Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-appservice-profile-2019-03-01-hybrid

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AccessControlEntryAction

AccessControlEntryAction: "Permit" | "Deny"

Defines values for AccessControlEntryAction. Possible values include: 'Permit', 'Deny'

readonly
enum

{string}

AppServicePlanRestrictions

AppServicePlanRestrictions: "None" | "Free" | "Shared" | "Basic" | "Standard" | "Premium"

Defines values for AppServicePlanRestrictions. Possible values include: 'None', 'Free', 'Shared', 'Basic', 'Standard', 'Premium'

readonly
enum

{string}

AppServicePlansBeginCreateOrUpdateResponse

AppServicePlansBeginCreateOrUpdateResponse: AppServicePlan & object

Contains response data for the beginCreateOrUpdate operation.

AppServicePlansCreateOrUpdateResponse

AppServicePlansCreateOrUpdateResponse: AppServicePlan & object

Contains response data for the createOrUpdate operation.

AppServicePlansCreateOrUpdateVnetRouteResponse

AppServicePlansCreateOrUpdateVnetRouteResponse: VnetRoute & object

Contains response data for the createOrUpdateVnetRoute operation.

AppServicePlansGetHybridConnectionPlanLimitResponse

AppServicePlansGetHybridConnectionPlanLimitResponse: HybridConnectionLimits & object

Contains response data for the getHybridConnectionPlanLimit operation.

AppServicePlansGetHybridConnectionResponse

AppServicePlansGetHybridConnectionResponse: HybridConnection & object

Contains response data for the getHybridConnection operation.

AppServicePlansGetResponse

AppServicePlansGetResponse: AppServicePlan & object

Contains response data for the get operation.

AppServicePlansGetRouteForVnetResponse

AppServicePlansGetRouteForVnetResponse: Array<VnetRoute> & object

Contains response data for the getRouteForVnet operation.

AppServicePlansGetServerFarmSkusResponse

AppServicePlansGetServerFarmSkusResponse: object

Contains response data for the getServerFarmSkus operation.

Type declaration

AppServicePlansGetVnetFromServerFarmResponse

AppServicePlansGetVnetFromServerFarmResponse: VnetInfo & object

Contains response data for the getVnetFromServerFarm operation.

AppServicePlansGetVnetGatewayResponse

AppServicePlansGetVnetGatewayResponse: VnetGateway & object

Contains response data for the getVnetGateway operation.

AppServicePlansListByResourceGroupNextResponse

AppServicePlansListByResourceGroupNextResponse: AppServicePlanCollection & object

Contains response data for the listByResourceGroupNext operation.

AppServicePlansListByResourceGroupResponse

AppServicePlansListByResourceGroupResponse: AppServicePlanCollection & object

Contains response data for the listByResourceGroup operation.

AppServicePlansListCapabilitiesResponse

AppServicePlansListCapabilitiesResponse: Array<Capability> & object

Contains response data for the listCapabilities operation.

AppServicePlansListHybridConnectionKeysResponse

AppServicePlansListHybridConnectionKeysResponse: HybridConnectionKey & object

Contains response data for the listHybridConnectionKeys operation.

AppServicePlansListHybridConnectionsNextResponse

AppServicePlansListHybridConnectionsNextResponse: HybridConnectionCollection & object

Contains response data for the listHybridConnectionsNext operation.

AppServicePlansListHybridConnectionsResponse

AppServicePlansListHybridConnectionsResponse: HybridConnectionCollection & object

Contains response data for the listHybridConnections operation.

AppServicePlansListMetricDefintionsNextResponse

AppServicePlansListMetricDefintionsNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefintionsNext operation.

AppServicePlansListMetricDefintionsResponse

AppServicePlansListMetricDefintionsResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefintions operation.

AppServicePlansListMetricsNextResponse

AppServicePlansListMetricsNextResponse: ResourceMetricCollection & object

Contains response data for the listMetricsNext operation.

AppServicePlansListMetricsResponse

AppServicePlansListMetricsResponse: ResourceMetricCollection & object

Contains response data for the listMetrics operation.

AppServicePlansListNextResponse

AppServicePlansListNextResponse: AppServicePlanCollection & object

Contains response data for the listNext operation.

AppServicePlansListResponse

AppServicePlansListResponse: AppServicePlanCollection & object

Contains response data for the list operation.

AppServicePlansListRoutesForVnetResponse

AppServicePlansListRoutesForVnetResponse: Array<VnetRoute> & object

Contains response data for the listRoutesForVnet operation.

AppServicePlansListUsagesNextResponse

AppServicePlansListUsagesNextResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsagesNext operation.

AppServicePlansListUsagesResponse

AppServicePlansListUsagesResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsages operation.

AppServicePlansListVnetsResponse

AppServicePlansListVnetsResponse: Array<VnetInfo> & object

Contains response data for the listVnets operation.

AppServicePlansListWebAppsByHybridConnectionNextResponse

AppServicePlansListWebAppsByHybridConnectionNextResponse: ResourceCollection & object

Contains response data for the listWebAppsByHybridConnectionNext operation.

AppServicePlansListWebAppsByHybridConnectionResponse

AppServicePlansListWebAppsByHybridConnectionResponse: ResourceCollection & object

Contains response data for the listWebAppsByHybridConnection operation.

AppServicePlansListWebAppsNextResponse

AppServicePlansListWebAppsNextResponse: WebAppCollection & object

Contains response data for the listWebAppsNext operation.

AppServicePlansListWebAppsResponse

AppServicePlansListWebAppsResponse: WebAppCollection & object

Contains response data for the listWebApps operation.

AppServicePlansUpdateResponse

AppServicePlansUpdateResponse: AppServicePlan & object

Contains response data for the update operation.

AppServicePlansUpdateVnetGatewayResponse

AppServicePlansUpdateVnetGatewayResponse: VnetGateway & object

Contains response data for the updateVnetGateway operation.

AppServicePlansUpdateVnetRouteResponse

AppServicePlansUpdateVnetRouteResponse: VnetRoute & object

Contains response data for the updateVnetRoute operation.

AutoHealActionType

AutoHealActionType: "Recycle" | "LogEvent" | "CustomAction"

Defines values for AutoHealActionType. Possible values include: 'Recycle', 'LogEvent', 'CustomAction'

readonly
enum

{string}

AzureResourceType

AzureResourceType: "Website" | "TrafficManager"

Defines values for AzureResourceType. Possible values include: 'Website', 'TrafficManager'

readonly
enum

{string}

AzureStorageState

AzureStorageState: "Ok" | "InvalidCredentials" | "InvalidShare"

Defines values for AzureStorageState. Possible values include: 'Ok', 'InvalidCredentials', 'InvalidShare'

readonly
enum

{string}

AzureStorageType

AzureStorageType: "AzureFiles" | "AzureBlob"

Defines values for AzureStorageType. Possible values include: 'AzureFiles', 'AzureBlob'

readonly
enum

{string}

BackupItemStatus

BackupItemStatus: "InProgress" | "Failed" | "Succeeded" | "TimedOut" | "Created" | "Skipped" | "PartiallySucceeded" | "DeleteInProgress" | "DeleteFailed" | "Deleted"

Defines values for BackupItemStatus. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created', 'Skipped', 'PartiallySucceeded', 'DeleteInProgress', 'DeleteFailed', 'Deleted'

readonly
enum

{string}

BackupRestoreOperationType

BackupRestoreOperationType: "Default" | "Clone" | "Relocation" | "Snapshot" | "CloudFS"

Defines values for BackupRestoreOperationType. Possible values include: 'Default', 'Clone', 'Relocation', 'Snapshot', 'CloudFS'

readonly
enum

{string}

BuiltInAuthenticationProvider

BuiltInAuthenticationProvider: "AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter"

Defines values for BuiltInAuthenticationProvider. Possible values include: 'AzureActiveDirectory', 'Facebook', 'Google', 'MicrosoftAccount', 'Twitter'

readonly
enum

{string}

CertificatesCreateOrUpdateResponse

CertificatesCreateOrUpdateResponse: Certificate & object

Contains response data for the createOrUpdate operation.

CertificatesGetResponse

CertificatesGetResponse: Certificate & object

Contains response data for the get operation.

CertificatesListByResourceGroupNextResponse

CertificatesListByResourceGroupNextResponse: CertificateCollection & object

Contains response data for the listByResourceGroupNext operation.

CertificatesListByResourceGroupResponse

CertificatesListByResourceGroupResponse: CertificateCollection & object

Contains response data for the listByResourceGroup operation.

CertificatesListNextResponse

CertificatesListNextResponse: CertificateCollection & object

Contains response data for the listNext operation.

CertificatesListResponse

CertificatesListResponse: CertificateCollection & object

Contains response data for the list operation.

CertificatesUpdateResponse

CertificatesUpdateResponse: Certificate & object

Contains response data for the update operation.

Channels

Channels: "Notification" | "Api" | "Email" | "Webhook" | "All"

Defines values for Channels. Possible values include: 'Notification', 'Api', 'Email', 'Webhook', 'All'

readonly
enum

{string}

CheckNameAvailabilityResponse

CheckNameAvailabilityResponse: ResourceNameAvailability & object

Contains response data for the checkNameAvailability operation.

CheckNameResourceTypes

CheckNameResourceTypes: "Site" | "Slot" | "HostingEnvironment" | "PublishingUser" | "Microsoft.Web/sites" | "Microsoft.Web/sites/slots" | "Microsoft.Web/hostingEnvironments" | "Microsoft.Web/publishingUsers"

Defines values for CheckNameResourceTypes. Possible values include: 'Site', 'Slot', 'HostingEnvironment', 'PublishingUser', 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots', 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'

readonly
enum

{string}

CloneAbilityResult

CloneAbilityResult: "Cloneable" | "PartiallyCloneable" | "NotCloneable"

Defines values for CloneAbilityResult. Possible values include: 'Cloneable', 'PartiallyCloneable', 'NotCloneable'

readonly
enum

{string}

ComputeModeOptions

ComputeModeOptions: "Shared" | "Dedicated" | "Dynamic"

Defines values for ComputeModeOptions. Possible values include: 'Shared', 'Dedicated', 'Dynamic'

readonly
enum

{string}

ConnectionStringType

ConnectionStringType: "MySql" | "SQLServer" | "SQLAzure" | "Custom" | "NotificationHub" | "ServiceBus" | "EventHub" | "ApiHub" | "DocDb" | "RedisCache" | "PostgreSQL"

Defines values for ConnectionStringType. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'

readonly
enum

{string}

ContinuousWebJobStatus

ContinuousWebJobStatus: "Initializing" | "Starting" | "Running" | "PendingRestart" | "Stopped"

Defines values for ContinuousWebJobStatus. Possible values include: 'Initializing', 'Starting', 'Running', 'PendingRestart', 'Stopped'

readonly
enum

{string}

CustomHostNameDnsRecordType

CustomHostNameDnsRecordType: "CName" | "A"

Defines values for CustomHostNameDnsRecordType. Possible values include: 'CName', 'A'

readonly
enum

{string}

DatabaseType

DatabaseType: "SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql"

Defines values for DatabaseType. Possible values include: 'SqlAzure', 'MySql', 'LocalMySql', 'PostgreSql'

readonly
enum

{string}

DnsVerificationTestResult

DnsVerificationTestResult: "Passed" | "Failed" | "Skipped"

Defines values for DnsVerificationTestResult. Possible values include: 'Passed', 'Failed', 'Skipped'

readonly
enum

{string}

FrequencyUnit

FrequencyUnit: "Day" | "Hour"

Defines values for FrequencyUnit. Possible values include: 'Day', 'Hour'

readonly
enum

{string}

FtpsState

FtpsState: "AllAllowed" | "FtpsOnly" | "Disabled"

Defines values for FtpsState. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'

readonly
enum

{string}

GetPublishingUserResponse

GetPublishingUserResponse: User & object

Contains response data for the getPublishingUser operation.

GetSourceControlResponse

GetSourceControlResponse: SourceControl & object

Contains response data for the getSourceControl operation.

GetSubscriptionDeploymentLocationsResponse

GetSubscriptionDeploymentLocationsResponse: DeploymentLocations & object

Contains response data for the getSubscriptionDeploymentLocations operation.

HostNameType

HostNameType: "Verified" | "Managed"

Defines values for HostNameType. Possible values include: 'Verified', 'Managed'

readonly
enum

{string}

HostType

HostType: "Standard" | "Repository"

Defines values for HostType. Possible values include: 'Standard', 'Repository'

readonly
enum

{string}

HostingEnvironmentStatus

HostingEnvironmentStatus: "Preparing" | "Ready" | "Scaling" | "Deleting"

Defines values for HostingEnvironmentStatus. Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'

readonly
enum

{string}

InAvailabilityReasonType

InAvailabilityReasonType: "Invalid" | "AlreadyExists"

Defines values for InAvailabilityReasonType. Possible values include: 'Invalid', 'AlreadyExists'

readonly
enum

{string}

InternalLoadBalancingMode

InternalLoadBalancingMode: "None" | "Web" | "Publishing"

Defines values for InternalLoadBalancingMode. Possible values include: 'None', 'Web', 'Publishing'

readonly
enum

{string}

IpFilterTag

IpFilterTag: "Default" | "XffProxy"

Defines values for IpFilterTag. Possible values include: 'Default', 'XffProxy'

readonly
enum

{string}

KeyVaultSecretStatus

KeyVaultSecretStatus: "Initialized" | "WaitingOnCertificateOrder" | "Succeeded" | "CertificateOrderFailed" | "OperationNotPermittedOnKeyVault" | "AzureServiceUnauthorizedToAccessKeyVault" | "KeyVaultDoesNotExist" | "KeyVaultSecretDoesNotExist" | "UnknownError" | "ExternalPrivateKey" | "Unknown"

Defines values for KeyVaultSecretStatus. Possible values include: 'Initialized', 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey', 'Unknown'

readonly
enum

{string}

ListBillingMetersNextResponse

ListBillingMetersNextResponse: BillingMeterCollection & object

Contains response data for the listBillingMetersNext operation.

ListBillingMetersResponse

ListBillingMetersResponse: BillingMeterCollection & object

Contains response data for the listBillingMeters operation.

ListGeoRegionsNextResponse

ListGeoRegionsNextResponse: GeoRegionCollection & object

Contains response data for the listGeoRegionsNext operation.

ListGeoRegionsResponse

ListGeoRegionsResponse: GeoRegionCollection & object

Contains response data for the listGeoRegions operation.

ListPremierAddOnOffersNextResponse

ListPremierAddOnOffersNextResponse: PremierAddOnOfferCollection & object

Contains response data for the listPremierAddOnOffersNext operation.

ListPremierAddOnOffersResponse

ListPremierAddOnOffersResponse: PremierAddOnOfferCollection & object

Contains response data for the listPremierAddOnOffers operation.

ListSiteIdentifiersAssignedToHostNameNextResponse

ListSiteIdentifiersAssignedToHostNameNextResponse: IdentifierCollection & object

Contains response data for the listSiteIdentifiersAssignedToHostNameNext operation.

ListSiteIdentifiersAssignedToHostNameResponse

ListSiteIdentifiersAssignedToHostNameResponse: IdentifierCollection & object

Contains response data for the listSiteIdentifiersAssignedToHostName operation.

ListSkusResponse

ListSkusResponse: SkuInfos & object

Contains response data for the listSkus operation.

ListSourceControlsNextResponse

ListSourceControlsNextResponse: SourceControlCollection & object

Contains response data for the listSourceControlsNext operation.

ListSourceControlsResponse

ListSourceControlsResponse: SourceControlCollection & object

Contains response data for the listSourceControls operation.

LogLevel

LogLevel: "Off" | "Verbose" | "Information" | "Warning" | "Error"

Defines values for LogLevel. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'

readonly
enum

{string}

MSDeployLogEntryType

MSDeployLogEntryType: "Message" | "Warning" | "Error"

Defines values for MSDeployLogEntryType. Possible values include: 'Message', 'Warning', 'Error'

readonly
enum

{string}

MSDeployProvisioningState

MSDeployProvisioningState: "accepted" | "running" | "succeeded" | "failed" | "canceled"

Defines values for MSDeployProvisioningState. Possible values include: 'accepted', 'running', 'succeeded', 'failed', 'canceled'

readonly
enum

{string}

ManagedPipelineMode

ManagedPipelineMode: "Integrated" | "Classic"

Defines values for ManagedPipelineMode. Possible values include: 'Integrated', 'Classic'

readonly
enum

{string}

ManagedServiceIdentityType

ManagedServiceIdentityType: "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None"

Defines values for ManagedServiceIdentityType. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

readonly
enum

{string}

MySqlMigrationType

MySqlMigrationType: "LocalToRemote" | "RemoteToLocal"

Defines values for MySqlMigrationType. Possible values include: 'LocalToRemote', 'RemoteToLocal'

readonly
enum

{string}

NotificationLevel

NotificationLevel: "Critical" | "Warning" | "Information" | "NonUrgentSuggestion"

Defines values for NotificationLevel. Possible values include: 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'

readonly
enum

{string}

OperationStatus

OperationStatus: "InProgress" | "Failed" | "Succeeded" | "TimedOut" | "Created"

Defines values for OperationStatus. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created'

readonly
enum

{string}

OsTypeSelected

OsTypeSelected: "Windows" | "Linux" | "WindowsFunctions" | "LinuxFunctions"

Defines values for OsTypeSelected. Possible values include: 'Windows', 'Linux', 'WindowsFunctions', 'LinuxFunctions'

readonly
enum

{string}

OsTypeSelected1

OsTypeSelected1: "Windows" | "Linux" | "WindowsFunctions" | "LinuxFunctions"

Defines values for OsTypeSelected1. Possible values include: 'Windows', 'Linux', 'WindowsFunctions', 'LinuxFunctions'

readonly
enum

{string}

ProviderGetAvailableStacksNextResponse

ProviderGetAvailableStacksNextResponse: ApplicationStackCollection & object

Contains response data for the getAvailableStacksNext operation.

ProviderGetAvailableStacksOnPremNextResponse

ProviderGetAvailableStacksOnPremNextResponse: ApplicationStackCollection & object

Contains response data for the getAvailableStacksOnPremNext operation.

ProviderGetAvailableStacksOnPremResponse

ProviderGetAvailableStacksOnPremResponse: ApplicationStackCollection & object

Contains response data for the getAvailableStacksOnPrem operation.

ProviderGetAvailableStacksResponse

ProviderGetAvailableStacksResponse: ApplicationStackCollection & object

Contains response data for the getAvailableStacks operation.

ProviderListOperationsNextResponse

ProviderListOperationsNextResponse: CsmOperationCollection & object

Contains response data for the listOperationsNext operation.

ProviderListOperationsResponse

ProviderListOperationsResponse: CsmOperationCollection & object

Contains response data for the listOperations operation.

ProvisioningState

ProvisioningState: "Succeeded" | "Failed" | "Canceled" | "InProgress" | "Deleting"

Defines values for ProvisioningState. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting'

readonly
enum

{string}

PublicCertificateLocation

PublicCertificateLocation: "CurrentUserMy" | "LocalMachineMy" | "Unknown"

Defines values for PublicCertificateLocation. Possible values include: 'CurrentUserMy', 'LocalMachineMy', 'Unknown'

readonly
enum

{string}

PublishingProfileFormat

PublishingProfileFormat: "FileZilla3" | "WebDeploy" | "Ftp"

Defines values for PublishingProfileFormat. Possible values include: 'FileZilla3', 'WebDeploy', 'Ftp'

readonly
enum

{string}

RecommendationsGetRuleDetailsByHostingEnvironmentResponse

RecommendationsGetRuleDetailsByHostingEnvironmentResponse: RecommendationRule & object

Contains response data for the getRuleDetailsByHostingEnvironment operation.

RecommendationsGetRuleDetailsByWebAppResponse

RecommendationsGetRuleDetailsByWebAppResponse: RecommendationRule & object

Contains response data for the getRuleDetailsByWebApp operation.

RecommendationsListHistoryForHostingEnvironmentNextResponse

RecommendationsListHistoryForHostingEnvironmentNextResponse: RecommendationCollection & object

Contains response data for the listHistoryForHostingEnvironmentNext operation.

RecommendationsListHistoryForHostingEnvironmentResponse

RecommendationsListHistoryForHostingEnvironmentResponse: RecommendationCollection & object

Contains response data for the listHistoryForHostingEnvironment operation.

RecommendationsListHistoryForWebAppNextResponse

RecommendationsListHistoryForWebAppNextResponse: RecommendationCollection & object

Contains response data for the listHistoryForWebAppNext operation.

RecommendationsListHistoryForWebAppResponse

RecommendationsListHistoryForWebAppResponse: RecommendationCollection & object

Contains response data for the listHistoryForWebApp operation.

RecommendationsListNextResponse

RecommendationsListNextResponse: RecommendationCollection & object

Contains response data for the listNext operation.

RecommendationsListRecommendedRulesForHostingEnvironmentNextResponse

RecommendationsListRecommendedRulesForHostingEnvironmentNextResponse: RecommendationCollection & object

Contains response data for the listRecommendedRulesForHostingEnvironmentNext operation.

RecommendationsListRecommendedRulesForHostingEnvironmentResponse

RecommendationsListRecommendedRulesForHostingEnvironmentResponse: RecommendationCollection & object

Contains response data for the listRecommendedRulesForHostingEnvironment operation.

RecommendationsListRecommendedRulesForWebAppNextResponse

RecommendationsListRecommendedRulesForWebAppNextResponse: RecommendationCollection & object

Contains response data for the listRecommendedRulesForWebAppNext operation.

RecommendationsListRecommendedRulesForWebAppResponse

RecommendationsListRecommendedRulesForWebAppResponse: RecommendationCollection & object

Contains response data for the listRecommendedRulesForWebApp operation.

RecommendationsListResponse

RecommendationsListResponse: RecommendationCollection & object

Contains response data for the list operation.

RedundancyMode

RedundancyMode: "None" | "Manual" | "Failover" | "ActiveActive" | "GeoRedundant"

Defines values for RedundancyMode. Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive', 'GeoRedundant'

readonly
enum

{string}

ResourceScopeType

ResourceScopeType: "ServerFarm" | "Subscription" | "WebSite"

Defines values for ResourceScopeType. Possible values include: 'ServerFarm', 'Subscription', 'WebSite'

readonly
enum

{string}

RouteType

RouteType: "DEFAULT" | "INHERITED" | "STATIC"

Defines values for RouteType. Possible values include: 'DEFAULT', 'INHERITED', 'STATIC'

readonly
enum

{string}

ScmType

ScmType: "None" | "Dropbox" | "Tfs" | "LocalGit" | "GitHub" | "CodePlexGit" | "CodePlexHg" | "BitbucketGit" | "BitbucketHg" | "ExternalGit" | "ExternalHg" | "OneDrive" | "VSO"

Defines values for ScmType. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive', 'VSO'

readonly
enum

{string}

SiteAvailabilityState

SiteAvailabilityState: "Normal" | "Limited" | "DisasterRecoveryMode"

Defines values for SiteAvailabilityState. Possible values include: 'Normal', 'Limited', 'DisasterRecoveryMode'

readonly
enum

{string}

SiteExtensionType

SiteExtensionType: "Gallery" | "WebRoot"

Defines values for SiteExtensionType. Possible values include: 'Gallery', 'WebRoot'

readonly
enum

{string}

SiteLoadBalancing

SiteLoadBalancing: "WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash"

Defines values for SiteLoadBalancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'

readonly
enum

{string}

SkuName

SkuName: "Free" | "Shared" | "Basic" | "Standard" | "Premium" | "Dynamic" | "Isolated" | "PremiumV2" | "ElasticPremium" | "ElasticIsolated"

Defines values for SkuName. Possible values include: 'Free', 'Shared', 'Basic', 'Standard', 'Premium', 'Dynamic', 'Isolated', 'PremiumV2', 'ElasticPremium', 'ElasticIsolated'

readonly
enum

{string}

SslState

SslState: "Disabled" | "SniEnabled" | "IpBasedEnabled"

Defines values for SslState. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'

readonly
enum

{string}

StatusOptions

StatusOptions: "Ready" | "Pending" | "Creating"

Defines values for StatusOptions. Possible values include: 'Ready', 'Pending', 'Creating'

readonly
enum

{string}

SupportedTlsVersions

SupportedTlsVersions: "1.0" | "1.1" | "1.2"

Defines values for SupportedTlsVersions. Possible values include: '1.0', '1.1', '1.2'

readonly
enum

{string}

TriggeredWebJobStatus

TriggeredWebJobStatus: "Success" | "Failed" | "Error"

Defines values for TriggeredWebJobStatus. Possible values include: 'Success', 'Failed', 'Error'

readonly
enum

{string}

UnauthenticatedClientAction

UnauthenticatedClientAction: "RedirectToLoginPage" | "AllowAnonymous"

Defines values for UnauthenticatedClientAction. Possible values include: 'RedirectToLoginPage', 'AllowAnonymous'

readonly
enum

{string}

UpdatePublishingUserResponse

UpdatePublishingUserResponse: User & object

Contains response data for the updatePublishingUser operation.

UpdateSourceControlResponse

UpdateSourceControlResponse: SourceControl & object

Contains response data for the updateSourceControl operation.

UsageState

UsageState: "Normal" | "Exceeded"

Defines values for UsageState. Possible values include: 'Normal', 'Exceeded'

readonly
enum

{string}

ValidateContainerSettingsResponse

ValidateContainerSettingsResponse: object

Contains response data for the validateContainerSettings operation.

Type declaration

ValidateResourceTypes

ValidateResourceTypes: "ServerFarm" | "Site"

Defines values for ValidateResourceTypes. Possible values include: 'ServerFarm', 'Site'

readonly
enum

{string}

ValidateResponse2

ValidateResponse2: ValidateResponse & object

Contains response data for the validate operation.

VerifyHostingEnvironmentVnetResponse

VerifyHostingEnvironmentVnetResponse: VnetValidationFailureDetails & object

Contains response data for the verifyHostingEnvironmentVnet operation.

WebAppsAddPremierAddOnResponse

WebAppsAddPremierAddOnResponse: PremierAddOn & object

Contains response data for the addPremierAddOn operation.

WebAppsAddPremierAddOnSlotResponse

WebAppsAddPremierAddOnSlotResponse: PremierAddOn & object

Contains response data for the addPremierAddOnSlot operation.

WebAppsAnalyzeCustomHostnameResponse

WebAppsAnalyzeCustomHostnameResponse: CustomHostnameAnalysisResult & object

Contains response data for the analyzeCustomHostname operation.

WebAppsAnalyzeCustomHostnameSlotResponse

WebAppsAnalyzeCustomHostnameSlotResponse: CustomHostnameAnalysisResult & object

Contains response data for the analyzeCustomHostnameSlot operation.

WebAppsBackupResponse

WebAppsBackupResponse: BackupItem & object

Contains response data for the backup operation.

WebAppsBackupSlotResponse

WebAppsBackupSlotResponse: BackupItem & object

Contains response data for the backupSlot operation.

WebAppsBeginCreateFunctionResponse

WebAppsBeginCreateFunctionResponse: FunctionEnvelope & object

Contains response data for the beginCreateFunction operation.

WebAppsBeginCreateInstanceFunctionSlotResponse

WebAppsBeginCreateInstanceFunctionSlotResponse: FunctionEnvelope & object

Contains response data for the beginCreateInstanceFunctionSlot operation.

WebAppsBeginCreateInstanceMSDeployOperationResponse

WebAppsBeginCreateInstanceMSDeployOperationResponse: MSDeployStatus & object

Contains response data for the beginCreateInstanceMSDeployOperation operation.

WebAppsBeginCreateInstanceMSDeployOperationSlotResponse

WebAppsBeginCreateInstanceMSDeployOperationSlotResponse: MSDeployStatus & object

Contains response data for the beginCreateInstanceMSDeployOperationSlot operation.

WebAppsBeginCreateMSDeployOperationResponse

WebAppsBeginCreateMSDeployOperationResponse: MSDeployStatus & object

Contains response data for the beginCreateMSDeployOperation operation.

WebAppsBeginCreateMSDeployOperationSlotResponse

WebAppsBeginCreateMSDeployOperationSlotResponse: MSDeployStatus & object

Contains response data for the beginCreateMSDeployOperationSlot operation.

WebAppsBeginCreateOrUpdateResponse

WebAppsBeginCreateOrUpdateResponse: Site & object

Contains response data for the beginCreateOrUpdate operation.

WebAppsBeginCreateOrUpdateSlotResponse

WebAppsBeginCreateOrUpdateSlotResponse: Site & object

Contains response data for the beginCreateOrUpdateSlot operation.

WebAppsBeginCreateOrUpdateSourceControlResponse

WebAppsBeginCreateOrUpdateSourceControlResponse: SiteSourceControl & object

Contains response data for the beginCreateOrUpdateSourceControl operation.

WebAppsBeginCreateOrUpdateSourceControlSlotResponse

WebAppsBeginCreateOrUpdateSourceControlSlotResponse: SiteSourceControl & object

Contains response data for the beginCreateOrUpdateSourceControlSlot operation.

WebAppsBeginInstallSiteExtensionResponse

WebAppsBeginInstallSiteExtensionResponse: SiteExtensionInfo & object

Contains response data for the beginInstallSiteExtension operation.

WebAppsBeginInstallSiteExtensionSlotResponse

WebAppsBeginInstallSiteExtensionSlotResponse: SiteExtensionInfo & object

Contains response data for the beginInstallSiteExtensionSlot operation.

WebAppsBeginListPublishingCredentialsResponse

WebAppsBeginListPublishingCredentialsResponse: User & object

Contains response data for the beginListPublishingCredentials operation.

WebAppsBeginListPublishingCredentialsSlotResponse

WebAppsBeginListPublishingCredentialsSlotResponse: User & object

Contains response data for the beginListPublishingCredentialsSlot operation.

WebAppsBeginMigrateMySqlResponse

WebAppsBeginMigrateMySqlResponse: Operation & object

Contains response data for the beginMigrateMySql operation.

WebAppsBeginMigrateStorageResponse

WebAppsBeginMigrateStorageResponse: StorageMigrationResponse & object

Contains response data for the beginMigrateStorage operation.

WebAppsBeginStartNetworkTraceResponse

WebAppsBeginStartNetworkTraceResponse: Array<NetworkTrace> & object

Contains response data for the beginStartNetworkTrace operation.

WebAppsBeginStartNetworkTraceSlotResponse

WebAppsBeginStartNetworkTraceSlotResponse: Array<NetworkTrace> & object

Contains response data for the beginStartNetworkTraceSlot operation.

WebAppsBeginStartWebSiteNetworkTraceOperationResponse

WebAppsBeginStartWebSiteNetworkTraceOperationResponse: Array<NetworkTrace> & object

Contains response data for the beginStartWebSiteNetworkTraceOperation operation.

WebAppsBeginStartWebSiteNetworkTraceOperationSlotResponse

WebAppsBeginStartWebSiteNetworkTraceOperationSlotResponse: Array<NetworkTrace> & object

Contains response data for the beginStartWebSiteNetworkTraceOperationSlot operation.

WebAppsCreateDeploymentResponse

WebAppsCreateDeploymentResponse: Deployment & object

Contains response data for the createDeployment operation.

WebAppsCreateDeploymentSlotResponse

WebAppsCreateDeploymentSlotResponse: Deployment & object

Contains response data for the createDeploymentSlot operation.

WebAppsCreateFunctionResponse

WebAppsCreateFunctionResponse: FunctionEnvelope & object

Contains response data for the createFunction operation.

WebAppsCreateInstanceFunctionSlotResponse

WebAppsCreateInstanceFunctionSlotResponse: FunctionEnvelope & object

Contains response data for the createInstanceFunctionSlot operation.

WebAppsCreateInstanceMSDeployOperationResponse

WebAppsCreateInstanceMSDeployOperationResponse: MSDeployStatus & object

Contains response data for the createInstanceMSDeployOperation operation.

WebAppsCreateInstanceMSDeployOperationSlotResponse

WebAppsCreateInstanceMSDeployOperationSlotResponse: MSDeployStatus & object

Contains response data for the createInstanceMSDeployOperationSlot operation.

WebAppsCreateMSDeployOperationResponse

WebAppsCreateMSDeployOperationResponse: MSDeployStatus & object

Contains response data for the createMSDeployOperation operation.

WebAppsCreateMSDeployOperationSlotResponse

WebAppsCreateMSDeployOperationSlotResponse: MSDeployStatus & object

Contains response data for the createMSDeployOperationSlot operation.

WebAppsCreateOrUpdateConfigurationResponse

WebAppsCreateOrUpdateConfigurationResponse: SiteConfigResource & object

Contains response data for the createOrUpdateConfiguration operation.

WebAppsCreateOrUpdateConfigurationSlotResponse

WebAppsCreateOrUpdateConfigurationSlotResponse: SiteConfigResource & object

Contains response data for the createOrUpdateConfigurationSlot operation.

WebAppsCreateOrUpdateDomainOwnershipIdentifierResponse

WebAppsCreateOrUpdateDomainOwnershipIdentifierResponse: Identifier & object

Contains response data for the createOrUpdateDomainOwnershipIdentifier operation.

WebAppsCreateOrUpdateDomainOwnershipIdentifierSlotResponse

WebAppsCreateOrUpdateDomainOwnershipIdentifierSlotResponse: Identifier & object

Contains response data for the createOrUpdateDomainOwnershipIdentifierSlot operation.

WebAppsCreateOrUpdateHostNameBindingResponse

WebAppsCreateOrUpdateHostNameBindingResponse: HostNameBinding & object

Contains response data for the createOrUpdateHostNameBinding operation.

WebAppsCreateOrUpdateHostNameBindingSlotResponse

WebAppsCreateOrUpdateHostNameBindingSlotResponse: HostNameBinding & object

Contains response data for the createOrUpdateHostNameBindingSlot operation.

WebAppsCreateOrUpdateHybridConnectionResponse

WebAppsCreateOrUpdateHybridConnectionResponse: HybridConnection & object

Contains response data for the createOrUpdateHybridConnection operation.

WebAppsCreateOrUpdateHybridConnectionSlotResponse

WebAppsCreateOrUpdateHybridConnectionSlotResponse: HybridConnection & object

Contains response data for the createOrUpdateHybridConnectionSlot operation.

WebAppsCreateOrUpdatePublicCertificateResponse

WebAppsCreateOrUpdatePublicCertificateResponse: PublicCertificate & object

Contains response data for the createOrUpdatePublicCertificate operation.

WebAppsCreateOrUpdatePublicCertificateSlotResponse

WebAppsCreateOrUpdatePublicCertificateSlotResponse: PublicCertificate & object

Contains response data for the createOrUpdatePublicCertificateSlot operation.

WebAppsCreateOrUpdateRelayServiceConnectionResponse

WebAppsCreateOrUpdateRelayServiceConnectionResponse: RelayServiceConnectionEntity & object

Contains response data for the createOrUpdateRelayServiceConnection operation.

WebAppsCreateOrUpdateRelayServiceConnectionSlotResponse

WebAppsCreateOrUpdateRelayServiceConnectionSlotResponse: RelayServiceConnectionEntity & object

Contains response data for the createOrUpdateRelayServiceConnectionSlot operation.

WebAppsCreateOrUpdateResponse

WebAppsCreateOrUpdateResponse: Site & object

Contains response data for the createOrUpdate operation.

WebAppsCreateOrUpdateSlotResponse

WebAppsCreateOrUpdateSlotResponse: Site & object

Contains response data for the createOrUpdateSlot operation.

WebAppsCreateOrUpdateSourceControlResponse

WebAppsCreateOrUpdateSourceControlResponse: SiteSourceControl & object

Contains response data for the createOrUpdateSourceControl operation.

WebAppsCreateOrUpdateSourceControlSlotResponse

WebAppsCreateOrUpdateSourceControlSlotResponse: SiteSourceControl & object

Contains response data for the createOrUpdateSourceControlSlot operation.

WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionResponse

WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionResponse: SwiftVirtualNetwork & object

Contains response data for the createOrUpdateSwiftVirtualNetworkConnection operation.

WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionSlotResponse

WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionSlotResponse: SwiftVirtualNetwork & object

Contains response data for the createOrUpdateSwiftVirtualNetworkConnectionSlot operation.

WebAppsCreateOrUpdateVnetConnectionGatewayResponse

WebAppsCreateOrUpdateVnetConnectionGatewayResponse: VnetGateway & object

Contains response data for the createOrUpdateVnetConnectionGateway operation.

WebAppsCreateOrUpdateVnetConnectionGatewaySlotResponse

WebAppsCreateOrUpdateVnetConnectionGatewaySlotResponse: VnetGateway & object

Contains response data for the createOrUpdateVnetConnectionGatewaySlot operation.

WebAppsCreateOrUpdateVnetConnectionResponse

WebAppsCreateOrUpdateVnetConnectionResponse: VnetInfo & object

Contains response data for the createOrUpdateVnetConnection operation.

WebAppsCreateOrUpdateVnetConnectionSlotResponse

WebAppsCreateOrUpdateVnetConnectionSlotResponse: VnetInfo & object

Contains response data for the createOrUpdateVnetConnectionSlot operation.

WebAppsDiscoverBackupResponse

WebAppsDiscoverBackupResponse: RestoreRequest & object

Contains response data for the discoverBackup operation.

WebAppsDiscoverBackupSlotResponse

WebAppsDiscoverBackupSlotResponse: RestoreRequest & object

Contains response data for the discoverBackupSlot operation.

WebAppsGetAuthSettingsResponse

WebAppsGetAuthSettingsResponse: SiteAuthSettings & object

Contains response data for the getAuthSettings operation.

WebAppsGetAuthSettingsSlotResponse

WebAppsGetAuthSettingsSlotResponse: SiteAuthSettings & object

Contains response data for the getAuthSettingsSlot operation.

WebAppsGetBackupConfigurationResponse

WebAppsGetBackupConfigurationResponse: BackupRequest & object

Contains response data for the getBackupConfiguration operation.

WebAppsGetBackupConfigurationSlotResponse

WebAppsGetBackupConfigurationSlotResponse: BackupRequest & object

Contains response data for the getBackupConfigurationSlot operation.

WebAppsGetBackupStatusResponse

WebAppsGetBackupStatusResponse: BackupItem & object

Contains response data for the getBackupStatus operation.

WebAppsGetBackupStatusSlotResponse

WebAppsGetBackupStatusSlotResponse: BackupItem & object

Contains response data for the getBackupStatusSlot operation.

WebAppsGetConfigurationResponse

WebAppsGetConfigurationResponse: SiteConfigResource & object

Contains response data for the getConfiguration operation.

WebAppsGetConfigurationSlotResponse

WebAppsGetConfigurationSlotResponse: SiteConfigResource & object

Contains response data for the getConfigurationSlot operation.

WebAppsGetConfigurationSnapshotResponse

WebAppsGetConfigurationSnapshotResponse: SiteConfigResource & object

Contains response data for the getConfigurationSnapshot operation.

WebAppsGetConfigurationSnapshotSlotResponse

WebAppsGetConfigurationSnapshotSlotResponse: SiteConfigResource & object

Contains response data for the getConfigurationSnapshotSlot operation.

WebAppsGetContainerLogsZipResponse

WebAppsGetContainerLogsZipResponse: object

Contains response data for the getContainerLogsZip operation.

Type declaration

WebAppsGetContainerLogsZipSlotResponse

WebAppsGetContainerLogsZipSlotResponse: object

Contains response data for the getContainerLogsZipSlot operation.

Type declaration

WebAppsGetContinuousWebJobResponse

WebAppsGetContinuousWebJobResponse: ContinuousWebJob & object

Contains response data for the getContinuousWebJob operation.

WebAppsGetContinuousWebJobSlotResponse

WebAppsGetContinuousWebJobSlotResponse: ContinuousWebJob & object

Contains response data for the getContinuousWebJobSlot operation.

WebAppsGetDeploymentResponse

WebAppsGetDeploymentResponse: Deployment & object

Contains response data for the getDeployment operation.

WebAppsGetDeploymentSlotResponse

WebAppsGetDeploymentSlotResponse: Deployment & object

Contains response data for the getDeploymentSlot operation.

WebAppsGetDiagnosticLogsConfigurationResponse

WebAppsGetDiagnosticLogsConfigurationResponse: SiteLogsConfig & object

Contains response data for the getDiagnosticLogsConfiguration operation.

WebAppsGetDiagnosticLogsConfigurationSlotResponse

WebAppsGetDiagnosticLogsConfigurationSlotResponse: SiteLogsConfig & object

Contains response data for the getDiagnosticLogsConfigurationSlot operation.

WebAppsGetDomainOwnershipIdentifierResponse

WebAppsGetDomainOwnershipIdentifierResponse: Identifier & object

Contains response data for the getDomainOwnershipIdentifier operation.

WebAppsGetDomainOwnershipIdentifierSlotResponse

WebAppsGetDomainOwnershipIdentifierSlotResponse: Identifier & object

Contains response data for the getDomainOwnershipIdentifierSlot operation.

WebAppsGetFunctionResponse

WebAppsGetFunctionResponse: FunctionEnvelope & object

Contains response data for the getFunction operation.

WebAppsGetFunctionsAdminTokenResponse

WebAppsGetFunctionsAdminTokenResponse: object

Contains response data for the getFunctionsAdminToken operation.

Type declaration

WebAppsGetFunctionsAdminTokenSlotResponse

WebAppsGetFunctionsAdminTokenSlotResponse: object

Contains response data for the getFunctionsAdminTokenSlot operation.

Type declaration

WebAppsGetHostNameBindingResponse

WebAppsGetHostNameBindingResponse: HostNameBinding & object

Contains response data for the getHostNameBinding operation.

WebAppsGetHostNameBindingSlotResponse

WebAppsGetHostNameBindingSlotResponse: HostNameBinding & object

Contains response data for the getHostNameBindingSlot operation.

WebAppsGetHybridConnectionResponse

WebAppsGetHybridConnectionResponse: HybridConnection & object

Contains response data for the getHybridConnection operation.

WebAppsGetHybridConnectionSlotResponse

WebAppsGetHybridConnectionSlotResponse: HybridConnection & object

Contains response data for the getHybridConnectionSlot operation.

WebAppsGetInstanceFunctionSlotResponse

WebAppsGetInstanceFunctionSlotResponse: FunctionEnvelope & object

Contains response data for the getInstanceFunctionSlot operation.

WebAppsGetInstanceMSDeployLogResponse

WebAppsGetInstanceMSDeployLogResponse: MSDeployLog & object

Contains response data for the getInstanceMSDeployLog operation.

WebAppsGetInstanceMSDeployLogSlotResponse

WebAppsGetInstanceMSDeployLogSlotResponse: MSDeployLog & object

Contains response data for the getInstanceMSDeployLogSlot operation.

WebAppsGetInstanceMsDeployStatusResponse

WebAppsGetInstanceMsDeployStatusResponse: MSDeployStatus & object

Contains response data for the getInstanceMsDeployStatus operation.

WebAppsGetInstanceMsDeployStatusSlotResponse

WebAppsGetInstanceMsDeployStatusSlotResponse: MSDeployStatus & object

Contains response data for the getInstanceMsDeployStatusSlot operation.

WebAppsGetInstanceProcessDumpResponse

WebAppsGetInstanceProcessDumpResponse: object

Contains response data for the getInstanceProcessDump operation.

Type declaration

WebAppsGetInstanceProcessDumpSlotResponse

WebAppsGetInstanceProcessDumpSlotResponse: object

Contains response data for the getInstanceProcessDumpSlot operation.

Type declaration

WebAppsGetInstanceProcessModuleResponse

WebAppsGetInstanceProcessModuleResponse: ProcessModuleInfo & object

Contains response data for the getInstanceProcessModule operation.

WebAppsGetInstanceProcessModuleSlotResponse

WebAppsGetInstanceProcessModuleSlotResponse: ProcessModuleInfo & object

Contains response data for the getInstanceProcessModuleSlot operation.

WebAppsGetInstanceProcessResponse

WebAppsGetInstanceProcessResponse: ProcessInfo & object

Contains response data for the getInstanceProcess operation.

WebAppsGetInstanceProcessSlotResponse

WebAppsGetInstanceProcessSlotResponse: ProcessInfo & object

Contains response data for the getInstanceProcessSlot operation.

WebAppsGetInstanceProcessThreadResponse

WebAppsGetInstanceProcessThreadResponse: ProcessThreadInfo & object

Contains response data for the getInstanceProcessThread operation.

WebAppsGetInstanceProcessThreadSlotResponse

WebAppsGetInstanceProcessThreadSlotResponse: ProcessThreadInfo & object

Contains response data for the getInstanceProcessThreadSlot operation.

WebAppsGetMSDeployLogResponse

WebAppsGetMSDeployLogResponse: MSDeployLog & object

Contains response data for the getMSDeployLog operation.

WebAppsGetMSDeployLogSlotResponse

WebAppsGetMSDeployLogSlotResponse: MSDeployLog & object

Contains response data for the getMSDeployLogSlot operation.

WebAppsGetMSDeployStatusResponse

WebAppsGetMSDeployStatusResponse: MSDeployStatus & object

Contains response data for the getMSDeployStatus operation.

WebAppsGetMSDeployStatusSlotResponse

WebAppsGetMSDeployStatusSlotResponse: MSDeployStatus & object

Contains response data for the getMSDeployStatusSlot operation.

WebAppsGetMigrateMySqlStatusResponse

WebAppsGetMigrateMySqlStatusResponse: MigrateMySqlStatus & object

Contains response data for the getMigrateMySqlStatus operation.

WebAppsGetMigrateMySqlStatusSlotResponse

WebAppsGetMigrateMySqlStatusSlotResponse: MigrateMySqlStatus & object

Contains response data for the getMigrateMySqlStatusSlot operation.

WebAppsGetNetworkTraceOperationResponse

WebAppsGetNetworkTraceOperationResponse: Array<NetworkTrace> & object

Contains response data for the getNetworkTraceOperation operation.

WebAppsGetNetworkTraceOperationSlotResponse

WebAppsGetNetworkTraceOperationSlotResponse: Array<NetworkTrace> & object

Contains response data for the getNetworkTraceOperationSlot operation.

WebAppsGetNetworkTraceOperationSlotV2Response

WebAppsGetNetworkTraceOperationSlotV2Response: Array<NetworkTrace> & object

Contains response data for the getNetworkTraceOperationSlotV2 operation.

WebAppsGetNetworkTraceOperationV2Response

WebAppsGetNetworkTraceOperationV2Response: Array<NetworkTrace> & object

Contains response data for the getNetworkTraceOperationV2 operation.

WebAppsGetNetworkTracesResponse

WebAppsGetNetworkTracesResponse: Array<NetworkTrace> & object

Contains response data for the getNetworkTraces operation.

WebAppsGetNetworkTracesSlotResponse

WebAppsGetNetworkTracesSlotResponse: Array<NetworkTrace> & object

Contains response data for the getNetworkTracesSlot operation.

WebAppsGetNetworkTracesSlotV2Response

WebAppsGetNetworkTracesSlotV2Response: Array<NetworkTrace> & object

Contains response data for the getNetworkTracesSlotV2 operation.

WebAppsGetNetworkTracesV2Response

WebAppsGetNetworkTracesV2Response: Array<NetworkTrace> & object

Contains response data for the getNetworkTracesV2 operation.

WebAppsGetPremierAddOnResponse

WebAppsGetPremierAddOnResponse: PremierAddOn & object

Contains response data for the getPremierAddOn operation.

WebAppsGetPremierAddOnSlotResponse

WebAppsGetPremierAddOnSlotResponse: PremierAddOn & object

Contains response data for the getPremierAddOnSlot operation.

WebAppsGetPrivateAccessResponse

WebAppsGetPrivateAccessResponse: PrivateAccess & object

Contains response data for the getPrivateAccess operation.

WebAppsGetPrivateAccessSlotResponse

WebAppsGetPrivateAccessSlotResponse: PrivateAccess & object

Contains response data for the getPrivateAccessSlot operation.

WebAppsGetProcessDumpResponse

WebAppsGetProcessDumpResponse: object

Contains response data for the getProcessDump operation.

Type declaration

WebAppsGetProcessDumpSlotResponse

WebAppsGetProcessDumpSlotResponse: object

Contains response data for the getProcessDumpSlot operation.

Type declaration

WebAppsGetProcessModuleResponse

WebAppsGetProcessModuleResponse: ProcessModuleInfo & object

Contains response data for the getProcessModule operation.

WebAppsGetProcessModuleSlotResponse

WebAppsGetProcessModuleSlotResponse: ProcessModuleInfo & object

Contains response data for the getProcessModuleSlot operation.

WebAppsGetProcessResponse

WebAppsGetProcessResponse: ProcessInfo & object

Contains response data for the getProcess operation.

WebAppsGetProcessSlotResponse

WebAppsGetProcessSlotResponse: ProcessInfo & object

Contains response data for the getProcessSlot operation.

WebAppsGetProcessThreadResponse

WebAppsGetProcessThreadResponse: ProcessThreadInfo & object

Contains response data for the getProcessThread operation.

WebAppsGetProcessThreadSlotResponse

WebAppsGetProcessThreadSlotResponse: ProcessThreadInfo & object

Contains response data for the getProcessThreadSlot operation.

WebAppsGetPublicCertificateResponse

WebAppsGetPublicCertificateResponse: PublicCertificate & object

Contains response data for the getPublicCertificate operation.

WebAppsGetPublicCertificateSlotResponse

WebAppsGetPublicCertificateSlotResponse: PublicCertificate & object

Contains response data for the getPublicCertificateSlot operation.

WebAppsGetRelayServiceConnectionResponse

WebAppsGetRelayServiceConnectionResponse: RelayServiceConnectionEntity & object

Contains response data for the getRelayServiceConnection operation.

WebAppsGetRelayServiceConnectionSlotResponse

WebAppsGetRelayServiceConnectionSlotResponse: RelayServiceConnectionEntity & object

Contains response data for the getRelayServiceConnectionSlot operation.

WebAppsGetResponse

WebAppsGetResponse: Site & object

Contains response data for the get operation.

WebAppsGetSiteExtensionResponse

WebAppsGetSiteExtensionResponse: SiteExtensionInfo & object

Contains response data for the getSiteExtension operation.

WebAppsGetSiteExtensionSlotResponse

WebAppsGetSiteExtensionSlotResponse: SiteExtensionInfo & object

Contains response data for the getSiteExtensionSlot operation.

WebAppsGetSitePhpErrorLogFlagResponse

WebAppsGetSitePhpErrorLogFlagResponse: SitePhpErrorLogFlag & object

Contains response data for the getSitePhpErrorLogFlag operation.

WebAppsGetSitePhpErrorLogFlagSlotResponse

WebAppsGetSitePhpErrorLogFlagSlotResponse: SitePhpErrorLogFlag & object

Contains response data for the getSitePhpErrorLogFlagSlot operation.

WebAppsGetSlotResponse

WebAppsGetSlotResponse: Site & object

Contains response data for the getSlot operation.

WebAppsGetSourceControlResponse

WebAppsGetSourceControlResponse: SiteSourceControl & object

Contains response data for the getSourceControl operation.

WebAppsGetSourceControlSlotResponse

WebAppsGetSourceControlSlotResponse: SiteSourceControl & object

Contains response data for the getSourceControlSlot operation.

WebAppsGetSwiftVirtualNetworkConnectionResponse

WebAppsGetSwiftVirtualNetworkConnectionResponse: SwiftVirtualNetwork & object

Contains response data for the getSwiftVirtualNetworkConnection operation.

WebAppsGetSwiftVirtualNetworkConnectionSlotResponse

WebAppsGetSwiftVirtualNetworkConnectionSlotResponse: SwiftVirtualNetwork & object

Contains response data for the getSwiftVirtualNetworkConnectionSlot operation.

WebAppsGetTriggeredWebJobHistoryResponse

WebAppsGetTriggeredWebJobHistoryResponse: TriggeredJobHistory & object

Contains response data for the getTriggeredWebJobHistory operation.

WebAppsGetTriggeredWebJobHistorySlotResponse

WebAppsGetTriggeredWebJobHistorySlotResponse: TriggeredJobHistory & object

Contains response data for the getTriggeredWebJobHistorySlot operation.

WebAppsGetTriggeredWebJobResponse

WebAppsGetTriggeredWebJobResponse: TriggeredWebJob & object

Contains response data for the getTriggeredWebJob operation.

WebAppsGetTriggeredWebJobSlotResponse

WebAppsGetTriggeredWebJobSlotResponse: TriggeredWebJob & object

Contains response data for the getTriggeredWebJobSlot operation.

WebAppsGetVnetConnectionGatewayResponse

WebAppsGetVnetConnectionGatewayResponse: VnetGateway & object

Contains response data for the getVnetConnectionGateway operation.

WebAppsGetVnetConnectionGatewaySlotResponse

WebAppsGetVnetConnectionGatewaySlotResponse: VnetGateway & object

Contains response data for the getVnetConnectionGatewaySlot operation.

WebAppsGetVnetConnectionResponse

WebAppsGetVnetConnectionResponse: VnetInfo & object

Contains response data for the getVnetConnection operation.

WebAppsGetVnetConnectionSlotResponse

WebAppsGetVnetConnectionSlotResponse: VnetInfo & object

Contains response data for the getVnetConnectionSlot operation.

WebAppsGetWebJobResponse

WebAppsGetWebJobResponse: WebJob & object

Contains response data for the getWebJob operation.

WebAppsGetWebJobSlotResponse

WebAppsGetWebJobSlotResponse: WebJob & object

Contains response data for the getWebJobSlot operation.

WebAppsGetWebSiteContainerLogsResponse

WebAppsGetWebSiteContainerLogsResponse: object

Contains response data for the getWebSiteContainerLogs operation.

Type declaration

WebAppsGetWebSiteContainerLogsSlotResponse

WebAppsGetWebSiteContainerLogsSlotResponse: object

Contains response data for the getWebSiteContainerLogsSlot operation.

Type declaration

WebAppsInstallSiteExtensionResponse

WebAppsInstallSiteExtensionResponse: SiteExtensionInfo & object

Contains response data for the installSiteExtension operation.

WebAppsInstallSiteExtensionSlotResponse

WebAppsInstallSiteExtensionSlotResponse: SiteExtensionInfo & object

Contains response data for the installSiteExtensionSlot operation.

WebAppsIsCloneableResponse

WebAppsIsCloneableResponse: SiteCloneability & object

Contains response data for the isCloneable operation.

WebAppsIsCloneableSlotResponse

WebAppsIsCloneableSlotResponse: SiteCloneability & object

Contains response data for the isCloneableSlot operation.

WebAppsListApplicationSettingsResponse

WebAppsListApplicationSettingsResponse: StringDictionary & object

Contains response data for the listApplicationSettings operation.

WebAppsListApplicationSettingsSlotResponse

WebAppsListApplicationSettingsSlotResponse: StringDictionary & object

Contains response data for the listApplicationSettingsSlot operation.

WebAppsListAzureStorageAccountsResponse

WebAppsListAzureStorageAccountsResponse: AzureStoragePropertyDictionaryResource & object

Contains response data for the listAzureStorageAccounts operation.

WebAppsListAzureStorageAccountsSlotResponse

WebAppsListAzureStorageAccountsSlotResponse: AzureStoragePropertyDictionaryResource & object

Contains response data for the listAzureStorageAccountsSlot operation.

WebAppsListBackupStatusSecretsResponse

WebAppsListBackupStatusSecretsResponse: BackupItem & object

Contains response data for the listBackupStatusSecrets operation.

WebAppsListBackupStatusSecretsSlotResponse

WebAppsListBackupStatusSecretsSlotResponse: BackupItem & object

Contains response data for the listBackupStatusSecretsSlot operation.

WebAppsListBackupsNextResponse

WebAppsListBackupsNextResponse: BackupItemCollection & object

Contains response data for the listBackupsNext operation.

WebAppsListBackupsResponse

WebAppsListBackupsResponse: BackupItemCollection & object

Contains response data for the listBackups operation.

WebAppsListBackupsSlotNextResponse

WebAppsListBackupsSlotNextResponse: BackupItemCollection & object

Contains response data for the listBackupsSlotNext operation.

WebAppsListBackupsSlotResponse

WebAppsListBackupsSlotResponse: BackupItemCollection & object

Contains response data for the listBackupsSlot operation.

WebAppsListByResourceGroupNextResponse

WebAppsListByResourceGroupNextResponse: WebAppCollection & object

Contains response data for the listByResourceGroupNext operation.

WebAppsListByResourceGroupResponse

WebAppsListByResourceGroupResponse: WebAppCollection & object

Contains response data for the listByResourceGroup operation.

WebAppsListConfigurationSnapshotInfoNextResponse

WebAppsListConfigurationSnapshotInfoNextResponse: SiteConfigurationSnapshotInfoCollection & object

Contains response data for the listConfigurationSnapshotInfoNext operation.

WebAppsListConfigurationSnapshotInfoResponse

WebAppsListConfigurationSnapshotInfoResponse: SiteConfigurationSnapshotInfoCollection & object

Contains response data for the listConfigurationSnapshotInfo operation.

WebAppsListConfigurationSnapshotInfoSlotNextResponse

WebAppsListConfigurationSnapshotInfoSlotNextResponse: SiteConfigurationSnapshotInfoCollection & object

Contains response data for the listConfigurationSnapshotInfoSlotNext operation.

WebAppsListConfigurationSnapshotInfoSlotResponse

WebAppsListConfigurationSnapshotInfoSlotResponse: SiteConfigurationSnapshotInfoCollection & object

Contains response data for the listConfigurationSnapshotInfoSlot operation.

WebAppsListConfigurationsNextResponse

WebAppsListConfigurationsNextResponse: SiteConfigResourceCollection & object

Contains response data for the listConfigurationsNext operation.

WebAppsListConfigurationsResponse

WebAppsListConfigurationsResponse: SiteConfigResourceCollection & object

Contains response data for the listConfigurations operation.

WebAppsListConfigurationsSlotNextResponse

WebAppsListConfigurationsSlotNextResponse: SiteConfigResourceCollection & object

Contains response data for the listConfigurationsSlotNext operation.

WebAppsListConfigurationsSlotResponse

WebAppsListConfigurationsSlotResponse: SiteConfigResourceCollection & object

Contains response data for the listConfigurationsSlot operation.

WebAppsListConnectionStringsResponse

WebAppsListConnectionStringsResponse: ConnectionStringDictionary & object

Contains response data for the listConnectionStrings operation.

WebAppsListConnectionStringsSlotResponse

WebAppsListConnectionStringsSlotResponse: ConnectionStringDictionary & object

Contains response data for the listConnectionStringsSlot operation.

WebAppsListContinuousWebJobsNextResponse

WebAppsListContinuousWebJobsNextResponse: ContinuousWebJobCollection & object

Contains response data for the listContinuousWebJobsNext operation.

WebAppsListContinuousWebJobsResponse

WebAppsListContinuousWebJobsResponse: ContinuousWebJobCollection & object

Contains response data for the listContinuousWebJobs operation.

WebAppsListContinuousWebJobsSlotNextResponse

WebAppsListContinuousWebJobsSlotNextResponse: ContinuousWebJobCollection & object

Contains response data for the listContinuousWebJobsSlotNext operation.

WebAppsListContinuousWebJobsSlotResponse

WebAppsListContinuousWebJobsSlotResponse: ContinuousWebJobCollection & object

Contains response data for the listContinuousWebJobsSlot operation.

WebAppsListDeploymentLogResponse

WebAppsListDeploymentLogResponse: Deployment & object

Contains response data for the listDeploymentLog operation.

WebAppsListDeploymentLogSlotResponse

WebAppsListDeploymentLogSlotResponse: Deployment & object

Contains response data for the listDeploymentLogSlot operation.

WebAppsListDeploymentsNextResponse

WebAppsListDeploymentsNextResponse: DeploymentCollection & object

Contains response data for the listDeploymentsNext operation.

WebAppsListDeploymentsResponse

WebAppsListDeploymentsResponse: DeploymentCollection & object

Contains response data for the listDeployments operation.

WebAppsListDeploymentsSlotNextResponse

WebAppsListDeploymentsSlotNextResponse: DeploymentCollection & object

Contains response data for the listDeploymentsSlotNext operation.

WebAppsListDeploymentsSlotResponse

WebAppsListDeploymentsSlotResponse: DeploymentCollection & object

Contains response data for the listDeploymentsSlot operation.

WebAppsListDomainOwnershipIdentifiersNextResponse

WebAppsListDomainOwnershipIdentifiersNextResponse: IdentifierCollection & object

Contains response data for the listDomainOwnershipIdentifiersNext operation.

WebAppsListDomainOwnershipIdentifiersResponse

WebAppsListDomainOwnershipIdentifiersResponse: IdentifierCollection & object

Contains response data for the listDomainOwnershipIdentifiers operation.

WebAppsListDomainOwnershipIdentifiersSlotNextResponse

WebAppsListDomainOwnershipIdentifiersSlotNextResponse: IdentifierCollection & object

Contains response data for the listDomainOwnershipIdentifiersSlotNext operation.

WebAppsListDomainOwnershipIdentifiersSlotResponse

WebAppsListDomainOwnershipIdentifiersSlotResponse: IdentifierCollection & object

Contains response data for the listDomainOwnershipIdentifiersSlot operation.

WebAppsListFunctionSecretsResponse

WebAppsListFunctionSecretsResponse: FunctionSecrets & object

Contains response data for the listFunctionSecrets operation.

WebAppsListFunctionSecretsSlotResponse

WebAppsListFunctionSecretsSlotResponse: FunctionSecrets & object

Contains response data for the listFunctionSecretsSlot operation.

WebAppsListFunctionsNextResponse

WebAppsListFunctionsNextResponse: FunctionEnvelopeCollection & object

Contains response data for the listFunctionsNext operation.

WebAppsListFunctionsResponse

WebAppsListFunctionsResponse: FunctionEnvelopeCollection & object

Contains response data for the listFunctions operation.

WebAppsListHostNameBindingsNextResponse

WebAppsListHostNameBindingsNextResponse: HostNameBindingCollection & object

Contains response data for the listHostNameBindingsNext operation.

WebAppsListHostNameBindingsResponse

WebAppsListHostNameBindingsResponse: HostNameBindingCollection & object

Contains response data for the listHostNameBindings operation.

WebAppsListHostNameBindingsSlotNextResponse

WebAppsListHostNameBindingsSlotNextResponse: HostNameBindingCollection & object

Contains response data for the listHostNameBindingsSlotNext operation.

WebAppsListHostNameBindingsSlotResponse

WebAppsListHostNameBindingsSlotResponse: HostNameBindingCollection & object

Contains response data for the listHostNameBindingsSlot operation.

WebAppsListHybridConnectionKeysResponse

WebAppsListHybridConnectionKeysResponse: HybridConnectionKey & object

Contains response data for the listHybridConnectionKeys operation.

WebAppsListHybridConnectionKeysSlotResponse

WebAppsListHybridConnectionKeysSlotResponse: HybridConnectionKey & object

Contains response data for the listHybridConnectionKeysSlot operation.

WebAppsListHybridConnectionsResponse

WebAppsListHybridConnectionsResponse: HybridConnection & object

Contains response data for the listHybridConnections operation.

WebAppsListHybridConnectionsSlotResponse

WebAppsListHybridConnectionsSlotResponse: HybridConnection & object

Contains response data for the listHybridConnectionsSlot operation.

WebAppsListInstanceFunctionsSlotNextResponse

WebAppsListInstanceFunctionsSlotNextResponse: FunctionEnvelopeCollection & object

Contains response data for the listInstanceFunctionsSlotNext operation.

WebAppsListInstanceFunctionsSlotResponse

WebAppsListInstanceFunctionsSlotResponse: FunctionEnvelopeCollection & object

Contains response data for the listInstanceFunctionsSlot operation.

WebAppsListInstanceIdentifiersNextResponse

WebAppsListInstanceIdentifiersNextResponse: WebAppInstanceCollection & object

Contains response data for the listInstanceIdentifiersNext operation.

WebAppsListInstanceIdentifiersResponse

WebAppsListInstanceIdentifiersResponse: WebAppInstanceCollection & object

Contains response data for the listInstanceIdentifiers operation.

WebAppsListInstanceIdentifiersSlotNextResponse

WebAppsListInstanceIdentifiersSlotNextResponse: WebAppInstanceCollection & object

Contains response data for the listInstanceIdentifiersSlotNext operation.

WebAppsListInstanceIdentifiersSlotResponse

WebAppsListInstanceIdentifiersSlotResponse: WebAppInstanceCollection & object

Contains response data for the listInstanceIdentifiersSlot operation.

WebAppsListInstanceProcessModulesNextResponse

WebAppsListInstanceProcessModulesNextResponse: ProcessModuleInfoCollection & object

Contains response data for the listInstanceProcessModulesNext operation.

WebAppsListInstanceProcessModulesResponse

WebAppsListInstanceProcessModulesResponse: ProcessModuleInfoCollection & object

Contains response data for the listInstanceProcessModules operation.

WebAppsListInstanceProcessModulesSlotNextResponse

WebAppsListInstanceProcessModulesSlotNextResponse: ProcessModuleInfoCollection & object

Contains response data for the listInstanceProcessModulesSlotNext operation.

WebAppsListInstanceProcessModulesSlotResponse

WebAppsListInstanceProcessModulesSlotResponse: ProcessModuleInfoCollection & object

Contains response data for the listInstanceProcessModulesSlot operation.

WebAppsListInstanceProcessThreadsNextResponse

WebAppsListInstanceProcessThreadsNextResponse: ProcessThreadInfoCollection & object

Contains response data for the listInstanceProcessThreadsNext operation.

WebAppsListInstanceProcessThreadsResponse

WebAppsListInstanceProcessThreadsResponse: ProcessThreadInfoCollection & object

Contains response data for the listInstanceProcessThreads operation.

WebAppsListInstanceProcessThreadsSlotNextResponse

WebAppsListInstanceProcessThreadsSlotNextResponse: ProcessThreadInfoCollection & object

Contains response data for the listInstanceProcessThreadsSlotNext operation.

WebAppsListInstanceProcessThreadsSlotResponse

WebAppsListInstanceProcessThreadsSlotResponse: ProcessThreadInfoCollection & object

Contains response data for the listInstanceProcessThreadsSlot operation.

WebAppsListInstanceProcessesNextResponse

WebAppsListInstanceProcessesNextResponse: ProcessInfoCollection & object

Contains response data for the listInstanceProcessesNext operation.

WebAppsListInstanceProcessesResponse

WebAppsListInstanceProcessesResponse: ProcessInfoCollection & object

Contains response data for the listInstanceProcesses operation.

WebAppsListInstanceProcessesSlotNextResponse

WebAppsListInstanceProcessesSlotNextResponse: ProcessInfoCollection & object

Contains response data for the listInstanceProcessesSlotNext operation.

WebAppsListInstanceProcessesSlotResponse

WebAppsListInstanceProcessesSlotResponse: ProcessInfoCollection & object

Contains response data for the listInstanceProcessesSlot operation.

WebAppsListMetadataResponse

WebAppsListMetadataResponse: StringDictionary & object

Contains response data for the listMetadata operation.

WebAppsListMetadataSlotResponse

WebAppsListMetadataSlotResponse: StringDictionary & object

Contains response data for the listMetadataSlot operation.

WebAppsListMetricDefinitionsNextResponse

WebAppsListMetricDefinitionsNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefinitionsNext operation.

WebAppsListMetricDefinitionsResponse

WebAppsListMetricDefinitionsResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefinitions operation.

WebAppsListMetricDefinitionsSlotNextResponse

WebAppsListMetricDefinitionsSlotNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefinitionsSlotNext operation.

WebAppsListMetricDefinitionsSlotResponse

WebAppsListMetricDefinitionsSlotResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefinitionsSlot operation.

WebAppsListMetricsNextResponse

WebAppsListMetricsNextResponse: ResourceMetricCollection & object

Contains response data for the listMetricsNext operation.

WebAppsListMetricsResponse

WebAppsListMetricsResponse: ResourceMetricCollection & object

Contains response data for the listMetrics operation.

WebAppsListMetricsSlotNextResponse

WebAppsListMetricsSlotNextResponse: ResourceMetricCollection & object

Contains response data for the listMetricsSlotNext operation.

WebAppsListMetricsSlotResponse

WebAppsListMetricsSlotResponse: ResourceMetricCollection & object

Contains response data for the listMetricsSlot operation.

WebAppsListNetworkFeaturesResponse

WebAppsListNetworkFeaturesResponse: NetworkFeatures & object

Contains response data for the listNetworkFeatures operation.

WebAppsListNetworkFeaturesSlotResponse

WebAppsListNetworkFeaturesSlotResponse: NetworkFeatures & object

Contains response data for the listNetworkFeaturesSlot operation.

WebAppsListNextResponse

WebAppsListNextResponse: WebAppCollection & object

Contains response data for the listNext operation.

WebAppsListPerfMonCountersNextResponse

WebAppsListPerfMonCountersNextResponse: PerfMonCounterCollection & object

Contains response data for the listPerfMonCountersNext operation.

WebAppsListPerfMonCountersResponse

WebAppsListPerfMonCountersResponse: PerfMonCounterCollection & object

Contains response data for the listPerfMonCounters operation.

WebAppsListPerfMonCountersSlotNextResponse

WebAppsListPerfMonCountersSlotNextResponse: PerfMonCounterCollection & object

Contains response data for the listPerfMonCountersSlotNext operation.

WebAppsListPerfMonCountersSlotResponse

WebAppsListPerfMonCountersSlotResponse: PerfMonCounterCollection & object

Contains response data for the listPerfMonCountersSlot operation.

WebAppsListPremierAddOnsResponse

WebAppsListPremierAddOnsResponse: PremierAddOn & object

Contains response data for the listPremierAddOns operation.

WebAppsListPremierAddOnsSlotResponse

WebAppsListPremierAddOnsSlotResponse: PremierAddOn & object

Contains response data for the listPremierAddOnsSlot operation.

WebAppsListProcessModulesNextResponse

WebAppsListProcessModulesNextResponse: ProcessModuleInfoCollection & object

Contains response data for the listProcessModulesNext operation.

WebAppsListProcessModulesResponse

WebAppsListProcessModulesResponse: ProcessModuleInfoCollection & object

Contains response data for the listProcessModules operation.

WebAppsListProcessModulesSlotNextResponse

WebAppsListProcessModulesSlotNextResponse: ProcessModuleInfoCollection & object

Contains response data for the listProcessModulesSlotNext operation.

WebAppsListProcessModulesSlotResponse

WebAppsListProcessModulesSlotResponse: ProcessModuleInfoCollection & object

Contains response data for the listProcessModulesSlot operation.

WebAppsListProcessThreadsNextResponse

WebAppsListProcessThreadsNextResponse: ProcessThreadInfoCollection & object

Contains response data for the listProcessThreadsNext operation.

WebAppsListProcessThreadsResponse

WebAppsListProcessThreadsResponse: ProcessThreadInfoCollection & object

Contains response data for the listProcessThreads operation.

WebAppsListProcessThreadsSlotNextResponse

WebAppsListProcessThreadsSlotNextResponse: ProcessThreadInfoCollection & object

Contains response data for the listProcessThreadsSlotNext operation.

WebAppsListProcessThreadsSlotResponse

WebAppsListProcessThreadsSlotResponse: ProcessThreadInfoCollection & object

Contains response data for the listProcessThreadsSlot operation.

WebAppsListProcessesNextResponse

WebAppsListProcessesNextResponse: ProcessInfoCollection & object

Contains response data for the listProcessesNext operation.

WebAppsListProcessesResponse

WebAppsListProcessesResponse: ProcessInfoCollection & object

Contains response data for the listProcesses operation.

WebAppsListProcessesSlotNextResponse

WebAppsListProcessesSlotNextResponse: ProcessInfoCollection & object

Contains response data for the listProcessesSlotNext operation.

WebAppsListProcessesSlotResponse

WebAppsListProcessesSlotResponse: ProcessInfoCollection & object

Contains response data for the listProcessesSlot operation.

WebAppsListPublicCertificatesNextResponse

WebAppsListPublicCertificatesNextResponse: PublicCertificateCollection & object

Contains response data for the listPublicCertificatesNext operation.

WebAppsListPublicCertificatesResponse

WebAppsListPublicCertificatesResponse: PublicCertificateCollection & object

Contains response data for the listPublicCertificates operation.

WebAppsListPublicCertificatesSlotNextResponse

WebAppsListPublicCertificatesSlotNextResponse: PublicCertificateCollection & object

Contains response data for the listPublicCertificatesSlotNext operation.

WebAppsListPublicCertificatesSlotResponse

WebAppsListPublicCertificatesSlotResponse: PublicCertificateCollection & object

Contains response data for the listPublicCertificatesSlot operation.

WebAppsListPublishingCredentialsResponse

WebAppsListPublishingCredentialsResponse: User & object

Contains response data for the listPublishingCredentials operation.

WebAppsListPublishingCredentialsSlotResponse

WebAppsListPublishingCredentialsSlotResponse: User & object

Contains response data for the listPublishingCredentialsSlot operation.

WebAppsListPublishingProfileXmlWithSecretsResponse

WebAppsListPublishingProfileXmlWithSecretsResponse: object

Contains response data for the listPublishingProfileXmlWithSecrets operation.

Type declaration

WebAppsListPublishingProfileXmlWithSecretsSlotResponse

WebAppsListPublishingProfileXmlWithSecretsSlotResponse: object

Contains response data for the listPublishingProfileXmlWithSecretsSlot operation.

Type declaration

WebAppsListRelayServiceConnectionsResponse

WebAppsListRelayServiceConnectionsResponse: RelayServiceConnectionEntity & object

Contains response data for the listRelayServiceConnections operation.

WebAppsListRelayServiceConnectionsSlotResponse

WebAppsListRelayServiceConnectionsSlotResponse: RelayServiceConnectionEntity & object

Contains response data for the listRelayServiceConnectionsSlot operation.

WebAppsListResponse

WebAppsListResponse: WebAppCollection & object

Contains response data for the list operation.

WebAppsListSiteExtensionsNextResponse

WebAppsListSiteExtensionsNextResponse: SiteExtensionInfoCollection & object

Contains response data for the listSiteExtensionsNext operation.

WebAppsListSiteExtensionsResponse

WebAppsListSiteExtensionsResponse: SiteExtensionInfoCollection & object

Contains response data for the listSiteExtensions operation.

WebAppsListSiteExtensionsSlotNextResponse

WebAppsListSiteExtensionsSlotNextResponse: SiteExtensionInfoCollection & object

Contains response data for the listSiteExtensionsSlotNext operation.

WebAppsListSiteExtensionsSlotResponse

WebAppsListSiteExtensionsSlotResponse: SiteExtensionInfoCollection & object

Contains response data for the listSiteExtensionsSlot operation.

WebAppsListSitePushSettingsResponse

WebAppsListSitePushSettingsResponse: PushSettings & object

Contains response data for the listSitePushSettings operation.

WebAppsListSitePushSettingsSlotResponse

WebAppsListSitePushSettingsSlotResponse: PushSettings & object

Contains response data for the listSitePushSettingsSlot operation.

WebAppsListSlotConfigurationNamesResponse

WebAppsListSlotConfigurationNamesResponse: SlotConfigNamesResource & object

Contains response data for the listSlotConfigurationNames operation.

WebAppsListSlotDifferencesFromProductionNextResponse

WebAppsListSlotDifferencesFromProductionNextResponse: SlotDifferenceCollection & object

Contains response data for the listSlotDifferencesFromProductionNext operation.

WebAppsListSlotDifferencesFromProductionResponse

WebAppsListSlotDifferencesFromProductionResponse: SlotDifferenceCollection & object

Contains response data for the listSlotDifferencesFromProduction operation.

WebAppsListSlotDifferencesSlotNextResponse

WebAppsListSlotDifferencesSlotNextResponse: SlotDifferenceCollection & object

Contains response data for the listSlotDifferencesSlotNext operation.

WebAppsListSlotDifferencesSlotResponse

WebAppsListSlotDifferencesSlotResponse: SlotDifferenceCollection & object

Contains response data for the listSlotDifferencesSlot operation.

WebAppsListSlotsNextResponse

WebAppsListSlotsNextResponse: WebAppCollection & object

Contains response data for the listSlotsNext operation.

WebAppsListSlotsResponse

WebAppsListSlotsResponse: WebAppCollection & object

Contains response data for the listSlots operation.

WebAppsListSnapshotsFromDRSecondaryNextResponse

WebAppsListSnapshotsFromDRSecondaryNextResponse: SnapshotCollection & object

Contains response data for the listSnapshotsFromDRSecondaryNext operation.

WebAppsListSnapshotsFromDRSecondaryResponse

WebAppsListSnapshotsFromDRSecondaryResponse: SnapshotCollection & object

Contains response data for the listSnapshotsFromDRSecondary operation.

WebAppsListSnapshotsFromDRSecondarySlotNextResponse

WebAppsListSnapshotsFromDRSecondarySlotNextResponse: SnapshotCollection & object

Contains response data for the listSnapshotsFromDRSecondarySlotNext operation.

WebAppsListSnapshotsFromDRSecondarySlotResponse

WebAppsListSnapshotsFromDRSecondarySlotResponse: SnapshotCollection & object

Contains response data for the listSnapshotsFromDRSecondarySlot operation.

WebAppsListSnapshotsNextResponse

WebAppsListSnapshotsNextResponse: SnapshotCollection & object

Contains response data for the listSnapshotsNext operation.

WebAppsListSnapshotsResponse

WebAppsListSnapshotsResponse: SnapshotCollection & object

Contains response data for the listSnapshots operation.

WebAppsListSnapshotsSlotNextResponse

WebAppsListSnapshotsSlotNextResponse: SnapshotCollection & object

Contains response data for the listSnapshotsSlotNext operation.

WebAppsListSnapshotsSlotResponse

WebAppsListSnapshotsSlotResponse: SnapshotCollection & object

Contains response data for the listSnapshotsSlot operation.

WebAppsListSyncFunctionTriggersResponse

WebAppsListSyncFunctionTriggersResponse: FunctionSecrets & object

Contains response data for the listSyncFunctionTriggers operation.

WebAppsListSyncFunctionTriggersSlotResponse

WebAppsListSyncFunctionTriggersSlotResponse: FunctionSecrets & object

Contains response data for the listSyncFunctionTriggersSlot operation.

WebAppsListTriggeredWebJobHistoryNextResponse

WebAppsListTriggeredWebJobHistoryNextResponse: TriggeredJobHistoryCollection & object

Contains response data for the listTriggeredWebJobHistoryNext operation.

WebAppsListTriggeredWebJobHistoryResponse

WebAppsListTriggeredWebJobHistoryResponse: TriggeredJobHistoryCollection & object

Contains response data for the listTriggeredWebJobHistory operation.

WebAppsListTriggeredWebJobHistorySlotNextResponse

WebAppsListTriggeredWebJobHistorySlotNextResponse: TriggeredJobHistoryCollection & object

Contains response data for the listTriggeredWebJobHistorySlotNext operation.

WebAppsListTriggeredWebJobHistorySlotResponse

WebAppsListTriggeredWebJobHistorySlotResponse: TriggeredJobHistoryCollection & object

Contains response data for the listTriggeredWebJobHistorySlot operation.

WebAppsListTriggeredWebJobsNextResponse

WebAppsListTriggeredWebJobsNextResponse: TriggeredWebJobCollection & object

Contains response data for the listTriggeredWebJobsNext operation.

WebAppsListTriggeredWebJobsResponse

WebAppsListTriggeredWebJobsResponse: TriggeredWebJobCollection & object

Contains response data for the listTriggeredWebJobs operation.

WebAppsListTriggeredWebJobsSlotNextResponse

WebAppsListTriggeredWebJobsSlotNextResponse: TriggeredWebJobCollection & object

Contains response data for the listTriggeredWebJobsSlotNext operation.

WebAppsListTriggeredWebJobsSlotResponse

WebAppsListTriggeredWebJobsSlotResponse: TriggeredWebJobCollection & object

Contains response data for the listTriggeredWebJobsSlot operation.

WebAppsListUsagesNextResponse

WebAppsListUsagesNextResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsagesNext operation.

WebAppsListUsagesResponse

WebAppsListUsagesResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsages operation.

WebAppsListUsagesSlotNextResponse

WebAppsListUsagesSlotNextResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsagesSlotNext operation.

WebAppsListUsagesSlotResponse

WebAppsListUsagesSlotResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsagesSlot operation.

WebAppsListVnetConnectionsResponse

WebAppsListVnetConnectionsResponse: Array<VnetInfo> & object

Contains response data for the listVnetConnections operation.

WebAppsListVnetConnectionsSlotResponse

WebAppsListVnetConnectionsSlotResponse: Array<VnetInfo> & object

Contains response data for the listVnetConnectionsSlot operation.

WebAppsListWebJobsNextResponse

WebAppsListWebJobsNextResponse: WebJobCollection & object

Contains response data for the listWebJobsNext operation.

WebAppsListWebJobsResponse

WebAppsListWebJobsResponse: WebJobCollection & object

Contains response data for the listWebJobs operation.

WebAppsListWebJobsSlotNextResponse

WebAppsListWebJobsSlotNextResponse: WebJobCollection & object

Contains response data for the listWebJobsSlotNext operation.

WebAppsListWebJobsSlotResponse

WebAppsListWebJobsSlotResponse: WebJobCollection & object

Contains response data for the listWebJobsSlot operation.

WebAppsMigrateMySqlResponse

WebAppsMigrateMySqlResponse: Operation & object

Contains response data for the migrateMySql operation.

WebAppsMigrateStorageResponse

WebAppsMigrateStorageResponse: StorageMigrationResponse & object

Contains response data for the migrateStorage operation.

WebAppsPutPrivateAccessVnetResponse

WebAppsPutPrivateAccessVnetResponse: PrivateAccess & object

Contains response data for the putPrivateAccessVnet operation.

WebAppsPutPrivateAccessVnetSlotResponse

WebAppsPutPrivateAccessVnetSlotResponse: PrivateAccess & object

Contains response data for the putPrivateAccessVnetSlot operation.

WebAppsStartNetworkTraceResponse

WebAppsStartNetworkTraceResponse: Array<NetworkTrace> & object

Contains response data for the startNetworkTrace operation.

WebAppsStartNetworkTraceSlotResponse

WebAppsStartNetworkTraceSlotResponse: Array<NetworkTrace> & object

Contains response data for the startNetworkTraceSlot operation.

WebAppsStartWebSiteNetworkTraceOperationResponse

WebAppsStartWebSiteNetworkTraceOperationResponse: Array<NetworkTrace> & object

Contains response data for the startWebSiteNetworkTraceOperation operation.

WebAppsStartWebSiteNetworkTraceOperationSlotResponse

WebAppsStartWebSiteNetworkTraceOperationSlotResponse: Array<NetworkTrace> & object

Contains response data for the startWebSiteNetworkTraceOperationSlot operation.

WebAppsStartWebSiteNetworkTraceResponse

WebAppsStartWebSiteNetworkTraceResponse: object

Contains response data for the startWebSiteNetworkTrace operation.

Type declaration

WebAppsStartWebSiteNetworkTraceSlotResponse

WebAppsStartWebSiteNetworkTraceSlotResponse: object

Contains response data for the startWebSiteNetworkTraceSlot operation.

Type declaration

WebAppsUpdateApplicationSettingsResponse

WebAppsUpdateApplicationSettingsResponse: StringDictionary & object

Contains response data for the updateApplicationSettings operation.

WebAppsUpdateApplicationSettingsSlotResponse

WebAppsUpdateApplicationSettingsSlotResponse: StringDictionary & object

Contains response data for the updateApplicationSettingsSlot operation.

WebAppsUpdateAuthSettingsResponse

WebAppsUpdateAuthSettingsResponse: SiteAuthSettings & object

Contains response data for the updateAuthSettings operation.

WebAppsUpdateAuthSettingsSlotResponse

WebAppsUpdateAuthSettingsSlotResponse: SiteAuthSettings & object

Contains response data for the updateAuthSettingsSlot operation.

WebAppsUpdateAzureStorageAccountsResponse

WebAppsUpdateAzureStorageAccountsResponse: AzureStoragePropertyDictionaryResource & object

Contains response data for the updateAzureStorageAccounts operation.

WebAppsUpdateAzureStorageAccountsSlotResponse

WebAppsUpdateAzureStorageAccountsSlotResponse: AzureStoragePropertyDictionaryResource & object

Contains response data for the updateAzureStorageAccountsSlot operation.

WebAppsUpdateBackupConfigurationResponse

WebAppsUpdateBackupConfigurationResponse: BackupRequest & object

Contains response data for the updateBackupConfiguration operation.

WebAppsUpdateBackupConfigurationSlotResponse

WebAppsUpdateBackupConfigurationSlotResponse: BackupRequest & object

Contains response data for the updateBackupConfigurationSlot operation.

WebAppsUpdateConfigurationResponse

WebAppsUpdateConfigurationResponse: SiteConfigResource & object

Contains response data for the updateConfiguration operation.

WebAppsUpdateConfigurationSlotResponse

WebAppsUpdateConfigurationSlotResponse: SiteConfigResource & object

Contains response data for the updateConfigurationSlot operation.

WebAppsUpdateConnectionStringsResponse

WebAppsUpdateConnectionStringsResponse: ConnectionStringDictionary & object

Contains response data for the updateConnectionStrings operation.

WebAppsUpdateConnectionStringsSlotResponse

WebAppsUpdateConnectionStringsSlotResponse: ConnectionStringDictionary & object

Contains response data for the updateConnectionStringsSlot operation.

WebAppsUpdateDiagnosticLogsConfigResponse

WebAppsUpdateDiagnosticLogsConfigResponse: SiteLogsConfig & object

Contains response data for the updateDiagnosticLogsConfig operation.

WebAppsUpdateDiagnosticLogsConfigSlotResponse

WebAppsUpdateDiagnosticLogsConfigSlotResponse: SiteLogsConfig & object

Contains response data for the updateDiagnosticLogsConfigSlot operation.

WebAppsUpdateDomainOwnershipIdentifierResponse

WebAppsUpdateDomainOwnershipIdentifierResponse: Identifier & object

Contains response data for the updateDomainOwnershipIdentifier operation.

WebAppsUpdateDomainOwnershipIdentifierSlotResponse

WebAppsUpdateDomainOwnershipIdentifierSlotResponse: Identifier & object

Contains response data for the updateDomainOwnershipIdentifierSlot operation.

WebAppsUpdateHybridConnectionResponse

WebAppsUpdateHybridConnectionResponse: HybridConnection & object

Contains response data for the updateHybridConnection operation.

WebAppsUpdateHybridConnectionSlotResponse

WebAppsUpdateHybridConnectionSlotResponse: HybridConnection & object

Contains response data for the updateHybridConnectionSlot operation.

WebAppsUpdateMetadataResponse

WebAppsUpdateMetadataResponse: StringDictionary & object

Contains response data for the updateMetadata operation.

WebAppsUpdateMetadataSlotResponse

WebAppsUpdateMetadataSlotResponse: StringDictionary & object

Contains response data for the updateMetadataSlot operation.

WebAppsUpdatePremierAddOnResponse

WebAppsUpdatePremierAddOnResponse: PremierAddOn & object

Contains response data for the updatePremierAddOn operation.

WebAppsUpdatePremierAddOnSlotResponse

WebAppsUpdatePremierAddOnSlotResponse: PremierAddOn & object

Contains response data for the updatePremierAddOnSlot operation.

WebAppsUpdateRelayServiceConnectionResponse

WebAppsUpdateRelayServiceConnectionResponse: RelayServiceConnectionEntity & object

Contains response data for the updateRelayServiceConnection operation.

WebAppsUpdateRelayServiceConnectionSlotResponse

WebAppsUpdateRelayServiceConnectionSlotResponse: RelayServiceConnectionEntity & object

Contains response data for the updateRelayServiceConnectionSlot operation.

WebAppsUpdateResponse

WebAppsUpdateResponse: Site & object

Contains response data for the update operation.

WebAppsUpdateSitePushSettingsResponse

WebAppsUpdateSitePushSettingsResponse: PushSettings & object

Contains response data for the updateSitePushSettings operation.

WebAppsUpdateSitePushSettingsSlotResponse

WebAppsUpdateSitePushSettingsSlotResponse: PushSettings & object

Contains response data for the updateSitePushSettingsSlot operation.

WebAppsUpdateSlotConfigurationNamesResponse

WebAppsUpdateSlotConfigurationNamesResponse: SlotConfigNamesResource & object

Contains response data for the updateSlotConfigurationNames operation.

WebAppsUpdateSlotResponse

WebAppsUpdateSlotResponse: Site & object

Contains response data for the updateSlot operation.

WebAppsUpdateSourceControlResponse

WebAppsUpdateSourceControlResponse: SiteSourceControl & object

Contains response data for the updateSourceControl operation.

WebAppsUpdateSourceControlSlotResponse

WebAppsUpdateSourceControlSlotResponse: SiteSourceControl & object

Contains response data for the updateSourceControlSlot operation.

WebAppsUpdateSwiftVirtualNetworkConnectionResponse

WebAppsUpdateSwiftVirtualNetworkConnectionResponse: SwiftVirtualNetwork & object

Contains response data for the updateSwiftVirtualNetworkConnection operation.

WebAppsUpdateSwiftVirtualNetworkConnectionSlotResponse

WebAppsUpdateSwiftVirtualNetworkConnectionSlotResponse: SwiftVirtualNetwork & object

Contains response data for the updateSwiftVirtualNetworkConnectionSlot operation.

WebAppsUpdateVnetConnectionGatewayResponse

WebAppsUpdateVnetConnectionGatewayResponse: VnetGateway & object

Contains response data for the updateVnetConnectionGateway operation.

WebAppsUpdateVnetConnectionGatewaySlotResponse

WebAppsUpdateVnetConnectionGatewaySlotResponse: VnetGateway & object

Contains response data for the updateVnetConnectionGatewaySlot operation.

WebAppsUpdateVnetConnectionResponse

WebAppsUpdateVnetConnectionResponse: VnetInfo & object

Contains response data for the updateVnetConnection operation.

WebAppsUpdateVnetConnectionSlotResponse

WebAppsUpdateVnetConnectionSlotResponse: VnetInfo & object

Contains response data for the updateVnetConnectionSlot operation.

WebJobType

WebJobType: "Continuous" | "Triggered"

Defines values for WebJobType. Possible values include: 'Continuous', 'Triggered'

readonly
enum

{string}

WorkerSizeOptions

WorkerSizeOptions: "Small" | "Medium" | "Large" | "D1" | "D2" | "D3" | "Default"

Defines values for WorkerSizeOptions. Possible values include: 'Small', 'Medium', 'Large', 'D1', 'D2', 'D3', 'Default'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const ApiDefinitionInfo

ApiDefinitionInfo: object

Information about the formal API definition for the app.

serializedName

serializedName: string = "ApiDefinitionInfo"

Optional url

url: undefined | string

The URL of the API definition.

type

type: object

className

className: string = "ApiDefinitionInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

name: "String" = "String"

Const AppServiceEnvironment

AppServiceEnvironment: object

Description of an App Service Environment.

Optional allowedMultiSizes

allowedMultiSizes: undefined | string

List of comma separated strings describing which VM sizes are allowed for front-ends. NOTE: This property will not be serialized. It can only be populated by the server.

Optional allowedWorkerSizes

allowedWorkerSizes: undefined | string

List of comma separated strings describing which VM sizes are allowed for workers. NOTE: This property will not be serialized. It can only be populated by the server.

Optional apiManagementAccountId

apiManagementAccountId: undefined | string

API Management Account associated with the App Service Environment.

Optional clusterSettings

clusterSettings: NameValuePair[]

Custom settings for changing the behavior of the App Service Environment.

Optional databaseEdition

databaseEdition: undefined | string

Edition of the metadata database for the App Service Environment, e.g. "Standard". NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseServiceObjective

databaseServiceObjective: undefined | string

Service objective of the metadata database for the App Service Environment, e.g. "S0". NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultFrontEndScaleFactor

defaultFrontEndScaleFactor: undefined | number

Default Scale Factor for FrontEnds. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsSuffix

dnsSuffix: undefined | string

DNS suffix of the App Service Environment.

Optional dynamicCacheEnabled

dynamicCacheEnabled: undefined | false | true

True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

Optional environmentCapacities

environmentCapacities: StampCapacity[]

Current total, used, and available worker capacities. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentIsHealthy

environmentIsHealthy: undefined | false | true

True/false indicating whether the App Service Environment is healthy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentStatus

environmentStatus: undefined | string

Detailed message about with results of the last check of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional frontEndScaleFactor

frontEndScaleFactor: undefined | number

Scale factor for front-ends.

Optional hasLinuxWorkers

hasLinuxWorkers: undefined | false | true

Flag that displays whether an ASE has linux workers or not

Optional internalLoadBalancingMode

internalLoadBalancingMode: InternalLoadBalancingMode

Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: 'None', 'Web', 'Publishing'

Optional ipsslAddressCount

ipsslAddressCount: undefined | number

Number of IP SSL addresses reserved for the App Service Environment.

Optional lastAction

lastAction: undefined | string

Last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastActionResult

lastActionResult: undefined | string

Result of the last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Location of the App Service Environment, e.g. "West US".

Optional maximumNumberOfMachines

maximumNumberOfMachines: undefined | number

Maximum number of VMs in the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional multiRoleCount

multiRoleCount: undefined | number

Number of front-end instances.

Optional multiSize

multiSize: undefined | string

Front-end VM size, e.g. "Medium", "Large".

name

name: string

Name of the App Service Environment.

Optional networkAccessControlList

networkAccessControlList: NetworkAccessControlEntry[]

Access control list for controlling traffic to the App Service Environment.

Optional provisioningState

provisioningState: ProvisioningState

Provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGroup

resourceGroup: undefined | string

Resource group of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceEnvironment"

Optional sslCertKeyVaultId

sslCertKeyVaultId: undefined | string

Key Vault ID for ILB App Service Environment default SSL certificate

Optional sslCertKeyVaultSecretName

sslCertKeyVaultSecretName: undefined | string

Key Vault Secret Name for ILB App Service Environment default SSL certificate

Optional status

Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscriptionId

subscriptionId: undefined | string

Subscription of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional suspended

suspended: undefined | false | true

true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

Optional upgradeDomains

upgradeDomains: undefined | number

Number of upgrade domains of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional userWhitelistedIpRanges

userWhitelistedIpRanges: string[]

User added ip ranges to whitelist on ASE db

Optional vipMappings

vipMappings: VirtualIPMapping[]

Description of IP SSL mapping for the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

virtualNetwork

virtualNetwork: VirtualNetworkProfile

Description of the Virtual Network.

Optional vnetName

vnetName: undefined | string

Name of the Virtual Network for the App Service Environment.

Optional vnetResourceGroupName

vnetResourceGroupName: undefined | string

Resource group of the Virtual Network.

Optional vnetSubnetName

vnetSubnetName: undefined | string

Subnet of the Virtual Network.

workerPools

workerPools: WorkerPool[]

Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

type

type: object

className

className: string = "AppServiceEnvironment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedMultiSizes

allowedMultiSizes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "allowedMultiSizes"

type

type: object

name

name: "String" = "String"

allowedWorkerSizes

allowedWorkerSizes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "allowedWorkerSizes"

type

type: object

name

name: "String" = "String"

apiManagementAccountId

apiManagementAccountId: object

serializedName

serializedName: string = "apiManagementAccountId"

type

type: object

name

name: "String" = "String"

clusterSettings

clusterSettings: object

serializedName

serializedName: string = "clusterSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

databaseEdition

databaseEdition: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "databaseEdition"

type

type: object

name

name: "String" = "String"

databaseServiceObjective

databaseServiceObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "databaseServiceObjective"

type

type: object

name

name: "String" = "String"

defaultFrontEndScaleFactor

defaultFrontEndScaleFactor: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "defaultFrontEndScaleFactor"

type

type: object

name

name: "Number" = "Number"

dnsSuffix

dnsSuffix: object

serializedName

serializedName: string = "dnsSuffix"

type

type: object

name

name: "String" = "String"

dynamicCacheEnabled

dynamicCacheEnabled: object

serializedName

serializedName: string = "dynamicCacheEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

environmentCapacities

environmentCapacities: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "environmentCapacities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StampCapacity"

name

name: "Composite" = "Composite"

environmentIsHealthy

environmentIsHealthy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "environmentIsHealthy"

type

type: object

name

name: "Boolean" = "Boolean"

environmentStatus

environmentStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "environmentStatus"

type

type: object

name

name: "String" = "String"

frontEndScaleFactor

frontEndScaleFactor: object

serializedName

serializedName: string = "frontEndScaleFactor"

type

type: object

name

name: "Number" = "Number"

hasLinuxWorkers

hasLinuxWorkers: object

serializedName

serializedName: string = "hasLinuxWorkers"

type

type: object

name

name: "Boolean" = "Boolean"

internalLoadBalancingMode

internalLoadBalancingMode: object

serializedName

serializedName: string = "internalLoadBalancingMode"

type

type: object

allowedValues

allowedValues: string[] = ["None","Web","Publishing"]

name

name: "Enum" = "Enum"

ipsslAddressCount

ipsslAddressCount: object

serializedName

serializedName: string = "ipsslAddressCount"

type

type: object

name

name: "Number" = "Number"

lastAction

lastAction: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastAction"

type

type: object

name

name: "String" = "String"

lastActionResult

lastActionResult: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastActionResult"

type

type: object

name

name: "String" = "String"

location

location: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

maximumNumberOfMachines

maximumNumberOfMachines: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maximumNumberOfMachines"

type

type: object

name

name: "Number" = "Number"

multiRoleCount

multiRoleCount: object

serializedName

serializedName: string = "multiRoleCount"

type

type: object

name

name: "Number" = "Number"

multiSize

multiSize: object

serializedName

serializedName: string = "multiSize"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

networkAccessControlList

networkAccessControlList: object

serializedName

serializedName: string = "networkAccessControlList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NetworkAccessControlEntry"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

name: "Enum" = "Enum"

resourceGroup

resourceGroup: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceGroup"

type

type: object

name

name: "String" = "String"

sslCertKeyVaultId

sslCertKeyVaultId: object

serializedName

serializedName: string = "sslCertKeyVaultId"

type

type: object

name

name: "String" = "String"

sslCertKeyVaultSecretName

sslCertKeyVaultSecretName: object

serializedName

serializedName: string = "sslCertKeyVaultSecretName"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["Preparing","Ready","Scaling","Deleting"]

name

name: "Enum" = "Enum"

subscriptionId

subscriptionId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

suspended

suspended: object

serializedName

serializedName: string = "suspended"

type

type: object

name

name: "Boolean" = "Boolean"

upgradeDomains

upgradeDomains: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "upgradeDomains"

type

type: object

name

name: "Number" = "Number"

userWhitelistedIpRanges

userWhitelistedIpRanges: object

serializedName

serializedName: string = "userWhitelistedIpRanges"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

vipMappings

vipMappings: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "vipMappings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualIPMapping"

name

name: "Composite" = "Composite"

virtualNetwork

virtualNetwork: object

required

required: true = true

serializedName

serializedName: string = "virtualNetwork"

type

type: object

className

className: string = "VirtualNetworkProfile"

name

name: "Composite" = "Composite"

vnetName

vnetName: object

serializedName

serializedName: string = "vnetName"

type

type: object

name

name: "String" = "String"

vnetResourceGroupName

vnetResourceGroupName: object

serializedName

serializedName: string = "vnetResourceGroupName"

type

type: object

name

name: "String" = "String"

vnetSubnetName

vnetSubnetName: object

serializedName

serializedName: string = "vnetSubnetName"

type

type: object

name

name: "String" = "String"

workerPools

workerPools: object

required

required: true = true

serializedName

serializedName: string = "workerPools"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkerPool"

name

name: "Composite" = "Composite"

Const AppServicePlan

AppServicePlan: object

App Service plan.

Optional freeOfferExpirationTime

freeOfferExpirationTime: Date

The time when the server farm free offer expires.

Optional geoRegion

geoRegion: undefined | string

Geographical location for the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

Specification for the App Service Environment to use for the App Service plan.

Optional hyperV

hyperV: undefined | false | true

If Hyper-V container app service plan true, false otherwise. Default value: false.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isSpot

isSpot: undefined | false | true

If true, this App Service Plan owns spot instances.

Optional isXenon

isXenon: undefined | false | true

Obsolete: If Hyper-V container app service plan true, false otherwise. Default value: false.

Optional kind

kind: undefined | string

Kind of resource.

location

location: string

Resource Location.

Optional maximumElasticWorkerCount

maximumElasticWorkerCount: undefined | number

Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

Optional maximumNumberOfWorkers

maximumNumberOfWorkers: undefined | number

Maximum number of instances that can be assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional numberOfSites

numberOfSites: undefined | number

Number of apps assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional perSiteScaling

perSiteScaling: undefined | false | true

If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan. Default value: false.

Optional provisioningState

provisioningState: ProvisioningState

Provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional reserved

reserved: undefined | false | true

If Linux app service plan true, false otherwise. Default value: false.

Optional resourceGroup

resourceGroup: undefined | string

Resource group of the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServicePlan"

Optional sku

Optional spotExpirationTime

spotExpirationTime: Date

The time when the server farm expires. Valid only if it is a spot server farm.

Optional status

App Service plan status. Possible values include: 'Ready', 'Pending', 'Creating' NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscription

subscription: undefined | string

App Service plan subscription. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

Optional targetWorkerCount

targetWorkerCount: undefined | number

Scaling worker count.

Optional targetWorkerSizeId

targetWorkerSizeId: undefined | number

Scaling worker size ID.

Optional workerTierName

workerTierName: undefined | string

Target worker tier assigned to the App Service plan.

type

type: object

className

className: string = "AppServicePlan"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

freeOfferExpirationTime

freeOfferExpirationTime: object

serializedName

serializedName: string = "properties.freeOfferExpirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

geoRegion

geoRegion: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.geoRegion"

type

type: object

name

name: "String" = "String"

hostingEnvironmentProfile

hostingEnvironmentProfile: object

serializedName

serializedName: string = "properties.hostingEnvironmentProfile"

type

type: object

className

className: string = "HostingEnvironmentProfile"

name

name: "Composite" = "Composite"

hyperV

hyperV: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.hyperV"

type

type: object

name

name: "Boolean" = "Boolean"

isSpot

isSpot: object

serializedName

serializedName: string = "properties.isSpot"

type

type: object

name

name: "Boolean" = "Boolean"

isXenon

isXenon: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.isXenon"

type

type: object

name

name: "Boolean" = "Boolean"

maximumElasticWorkerCount

maximumElasticWorkerCount: object

serializedName

serializedName: string = "properties.maximumElasticWorkerCount"

type

type: object

name

name: "Number" = "Number"

maximumNumberOfWorkers

maximumNumberOfWorkers: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maximumNumberOfWorkers"

type

type: object

name

name: "Number" = "Number"

numberOfSites

numberOfSites: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.numberOfSites"

type

type: object

name

name: "Number" = "Number"

perSiteScaling

perSiteScaling: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.perSiteScaling"

type

type: object

name

name: "Boolean" = "Boolean"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

name: "Enum" = "Enum"

reserved

reserved: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.reserved"

type

type: object

name

name: "Boolean" = "Boolean"

resourceGroup

resourceGroup: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGroup"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "SkuDescription"

name

name: "Composite" = "Composite"

spotExpirationTime

spotExpirationTime: object

serializedName

serializedName: string = "properties.spotExpirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["Ready","Pending","Creating"]

name

name: "Enum" = "Enum"

subscription

subscription: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subscription"

type

type: object

name

name: "String" = "String"

targetWorkerCount

targetWorkerCount: object

serializedName

serializedName: string = "properties.targetWorkerCount"

type

type: object

name

name: "Number" = "Number"

targetWorkerSizeId

targetWorkerSizeId: object

serializedName

serializedName: string = "properties.targetWorkerSizeId"

type

type: object

name

name: "Number" = "Number"

workerTierName

workerTierName: object

serializedName

serializedName: string = "properties.workerTierName"

type

type: object

name

name: "String" = "String"

Const AppServicePlanCollection

AppServicePlanCollection: object
interface

Collection of App Service plans.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServicePlanCollection"

__@iterator

  • __@iterator(): IterableIterator<AppServicePlan>
  • Iterator

    Returns IterableIterator<AppServicePlan>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<AppServicePlan>[]): AppServicePlan[]
  • concat(...items: (T | ConcatArray<T>)[]): AppServicePlan[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AppServicePlan>[]

      Additional items to add to the end of array1.

    Returns AppServicePlan[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AppServicePlan[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, AppServicePlan]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AppServicePlan]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: AppServicePlan, index: number, array: AppServicePlan[]): boolean
        • Parameters

          • value: AppServicePlan
          • index: number
          • array: AppServicePlan[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AppServicePlan, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AppServicePlan

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AppServicePlan[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: AppServicePlan

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AppServicePlan, index: number, array: AppServicePlan[]): boolean
        • Parameters

          • value: AppServicePlan
          • index: number
          • array: AppServicePlan[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: AppServicePlan, index: number, array: AppServicePlan[]): any
        • Parameters

          • value: AppServicePlan
          • index: number
          • array: AppServicePlan[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AppServicePlan[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AppServicePlan | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: AppServicePlan

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: AppServicePlan, index: number, obj: AppServicePlan[]): boolean
        • Parameters

          • this: void
          • value: AppServicePlan
          • index: number
          • obj: AppServicePlan[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: AppServicePlan, index: number, obj: AppServicePlan[]): boolean
        • Parameters

          • value: AppServicePlan
          • index: number
          • obj: AppServicePlan[]

          Returns boolean

    • Optional thisArg: any

    Returns AppServicePlan | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: AppServicePlan, index: number, obj: AppServicePlan[]): boolean
        • Parameters

          • value: AppServicePlan
          • index: number
          • obj: AppServicePlan[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: AppServicePlan, index: number, array: AppServicePlan[]): void
        • Parameters

          • value: AppServicePlan
          • index: number
          • array: AppServicePlan[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: AppServicePlan, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AppServicePlan

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: AppServicePlan, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AppServicePlan

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: AppServicePlan, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AppServicePlan

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: AppServicePlan, index: number, array: AppServicePlan[]): U
        • Parameters

          • value: AppServicePlan
          • index: number
          • array: AppServicePlan[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): AppServicePlan | undefined
  • Removes the last element from an array and returns it.

    Returns AppServicePlan | undefined

push

  • push(...items: AppServicePlan[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: AppServicePlan[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): AppServicePlan
  • reduce(callbackfn: function, initialValue: AppServicePlan): AppServicePlan
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: AppServicePlan, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): AppServicePlan
        • Parameters

          • previousValue: AppServicePlan
          • currentValue: AppServicePlan
          • currentIndex: number
          • array: AppServicePlan[]

          Returns AppServicePlan

    Returns AppServicePlan

  • Parameters

    • callbackfn: function
        • (previousValue: AppServicePlan, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): AppServicePlan
        • Parameters

          • previousValue: AppServicePlan
          • currentValue: AppServicePlan
          • currentIndex: number
          • array: AppServicePlan[]

          Returns AppServicePlan

    • initialValue: AppServicePlan

    Returns AppServicePlan

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): U
        • Parameters

          • previousValue: U
          • currentValue: AppServicePlan
          • currentIndex: number
          • array: AppServicePlan[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): AppServicePlan
  • reduceRight(callbackfn: function, initialValue: AppServicePlan): AppServicePlan
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: AppServicePlan, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): AppServicePlan
        • Parameters

          • previousValue: AppServicePlan
          • currentValue: AppServicePlan
          • currentIndex: number
          • array: AppServicePlan[]

          Returns AppServicePlan

    Returns AppServicePlan

  • Parameters

    • callbackfn: function
        • (previousValue: AppServicePlan, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): AppServicePlan
        • Parameters

          • previousValue: AppServicePlan
          • currentValue: AppServicePlan
          • currentIndex: number
          • array: AppServicePlan[]

          Returns AppServicePlan

    • initialValue: AppServicePlan

    Returns AppServicePlan

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): U
        • Parameters

          • previousValue: U
          • currentValue: AppServicePlan
          • currentIndex: number
          • array: AppServicePlan[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): AppServicePlan[]
  • Reverses the elements in an Array.

    Returns AppServicePlan[]

shift

  • shift(): AppServicePlan | undefined
  • Removes the first element from an array and returns it.

    Returns AppServicePlan | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): AppServicePlan[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AppServicePlan[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: AppServicePlan, index: number, array: AppServicePlan[]): boolean
        • Parameters

          • value: AppServicePlan
          • index: number
          • array: AppServicePlan[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): AppServicePlan[]
  • splice(start: number, deleteCount: number, ...items: AppServicePlan[]): AppServicePlan[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AppServicePlan[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AppServicePlan[]

      Elements to insert into the array in place of the deleted elements.

    Returns AppServicePlan[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: AppServicePlan[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: AppServicePlan[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<AppServicePlan>
  • Returns an iterable of values in the array

    Returns IterableIterator<AppServicePlan>

type

type: object

className

className: string = "AppServicePlanCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AppServicePlan"

name

name: "Composite" = "Composite"

Const AppServicePlanPatchResource

AppServicePlanPatchResource: object

ARM resource for a app service plan.

Optional freeOfferExpirationTime

freeOfferExpirationTime: Date

The time when the server farm free offer expires.

Optional geoRegion

geoRegion: undefined | string

Geographical location for the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

Specification for the App Service Environment to use for the App Service plan.

Optional hyperV

hyperV: undefined | false | true

If Hyper-V container app service plan true, false otherwise. Default value: false.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isSpot

isSpot: undefined | false | true

If true, this App Service Plan owns spot instances.

Optional isXenon

isXenon: undefined | false | true

Obsolete: If Hyper-V container app service plan true, false otherwise. Default value: false.

Optional kind

kind: undefined | string

Kind of resource.

Optional maximumElasticWorkerCount

maximumElasticWorkerCount: undefined | number

Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

Optional maximumNumberOfWorkers

maximumNumberOfWorkers: undefined | number

Maximum number of instances that can be assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional numberOfSites

numberOfSites: undefined | number

Number of apps assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional perSiteScaling

perSiteScaling: undefined | false | true

If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan. Default value: false.

Optional provisioningState

provisioningState: ProvisioningState

Provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional reserved

reserved: undefined | false | true

If Linux app service plan true, false otherwise. Default value: false.

Optional resourceGroup

resourceGroup: undefined | string

Resource group of the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServicePlanPatchResource"

Optional spotExpirationTime

spotExpirationTime: Date

The time when the server farm expires. Valid only if it is a spot server farm.

Optional status

App Service plan status. Possible values include: 'Ready', 'Pending', 'Creating' NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscription

subscription: undefined | string

App Service plan subscription. NOTE: This property will not be serialized. It can only be populated by the server.

Optional targetWorkerCount

targetWorkerCount: undefined | number

Scaling worker count.

Optional targetWorkerSizeId

targetWorkerSizeId: undefined | number

Scaling worker size ID.

Optional workerTierName

workerTierName: undefined | string

Target worker tier assigned to the App Service plan.

type

type: object

className

className: string = "AppServicePlanPatchResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

freeOfferExpirationTime

freeOfferExpirationTime: object

serializedName

serializedName: string = "properties.freeOfferExpirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

geoRegion

geoRegion: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.geoRegion"

type

type: object

name

name: "String" = "String"

hostingEnvironmentProfile

hostingEnvironmentProfile: object

serializedName

serializedName: string = "properties.hostingEnvironmentProfile"

type

type: object

className

className: string = "HostingEnvironmentProfile"

name

name: "Composite" = "Composite"

hyperV

hyperV: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.hyperV"

type

type: object

name

name: "Boolean" = "Boolean"

isSpot

isSpot: object

serializedName

serializedName: string = "properties.isSpot"

type

type: object

name

name: "Boolean" = "Boolean"

isXenon

isXenon: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.isXenon"

type

type: object

name

name: "Boolean" = "Boolean"

maximumElasticWorkerCount

maximumElasticWorkerCount: object

serializedName

serializedName: string = "properties.maximumElasticWorkerCount"

type

type: object

name

name: "Number" = "Number"

maximumNumberOfWorkers

maximumNumberOfWorkers: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maximumNumberOfWorkers"

type

type: object

name

name: "Number" = "Number"

numberOfSites

numberOfSites: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.numberOfSites"

type

type: object

name

name: "Number" = "Number"

perSiteScaling

perSiteScaling: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.perSiteScaling"

type

type: object

name

name: "Boolean" = "Boolean"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

name: "Enum" = "Enum"

reserved

reserved: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.reserved"

type

type: object

name

name: "Boolean" = "Boolean"

resourceGroup

resourceGroup: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGroup"

type

type: object

name

name: "String" = "String"

spotExpirationTime

spotExpirationTime: object

serializedName

serializedName: string = "properties.spotExpirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["Ready","Pending","Creating"]

name

name: "Enum" = "Enum"

subscription

subscription: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subscription"

type

type: object

name

name: "String" = "String"

targetWorkerCount

targetWorkerCount: object

serializedName

serializedName: string = "properties.targetWorkerCount"

type

type: object

name

name: "Number" = "Number"

targetWorkerSizeId

targetWorkerSizeId: object

serializedName

serializedName: string = "properties.targetWorkerSizeId"

type

type: object

name

name: "Number" = "Number"

workerTierName

workerTierName: object

serializedName

serializedName: string = "properties.workerTierName"

type

type: object

name

name: "String" = "String"

Const ApplicationLogsConfig

ApplicationLogsConfig: object

Application logs configuration.

Optional azureBlobStorage

Application logs to blob storage configuration.

Optional azureTableStorage

Application logs to azure table storage configuration.

Optional fileSystem

Application logs to file system configuration.

serializedName

serializedName: string = "ApplicationLogsConfig"

type

type: object

className

className: string = "ApplicationLogsConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureBlobStorage

azureBlobStorage: object

serializedName

serializedName: string = "azureBlobStorage"

type

type: object

className

className: string = "AzureBlobStorageApplicationLogsConfig"

name

name: "Composite" = "Composite"

azureTableStorage

azureTableStorage: object

serializedName

serializedName: string = "azureTableStorage"

type

type: object

className

className: string = "AzureTableStorageApplicationLogsConfig"

name

name: "Composite" = "Composite"

fileSystem

fileSystem: object

serializedName

serializedName: string = "fileSystem"

type

type: object

className

className: string = "FileSystemApplicationLogsConfig"

name

name: "Composite" = "Composite"

Const ApplicationStack

ApplicationStack: object

Application stack.

Optional dependency

dependency: undefined | string

Application stack dependency.

Optional display

display: undefined | string

Application stack display name.

Optional frameworks

frameworks: ApplicationStack[]

List of frameworks associated with application stack.

Optional majorVersions

majorVersions: StackMajorVersion[]

List of major versions available.

Optional name

name: undefined | string

Application stack name.

serializedName

serializedName: string = "ApplicationStack"

type

type: object

className

className: string = "ApplicationStack"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dependency

dependency: object

serializedName

serializedName: string = "dependency"

type

type: object

name

name: "String" = "String"

display

display: object

serializedName

serializedName: string = "display"

type

type: object

name

name: "String" = "String"

frameworks

frameworks: object

serializedName

serializedName: string = "frameworks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationStack"

name

name: "Composite" = "Composite"

majorVersions

majorVersions: object

serializedName

serializedName: string = "majorVersions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StackMajorVersion"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const ApplicationStackCollection

ApplicationStackCollection: object
interface

Collection of Application Stacks

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApplicationStackCollection"

__@iterator

  • __@iterator(): IterableIterator<ApplicationStack>
  • Iterator

    Returns IterableIterator<ApplicationStack>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ApplicationStack>[]): ApplicationStack[]
  • concat(...items: (T | ConcatArray<T>)[]): ApplicationStack[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ApplicationStack>[]

      Additional items to add to the end of array1.

    Returns ApplicationStack[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ApplicationStack[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ApplicationStack]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ApplicationStack]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ApplicationStack, index: number, array: ApplicationStack[]): boolean
        • Parameters

          • value: ApplicationStack
          • index: number
          • array: ApplicationStack[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ApplicationStack, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ApplicationStack

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ApplicationStack[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ApplicationStack

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationStack, index: number, array: ApplicationStack[]): boolean
        • Parameters

          • value: ApplicationStack
          • index: number
          • array: ApplicationStack[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationStack, index: number, array: ApplicationStack[]): any
        • Parameters

          • value: ApplicationStack
          • index: number
          • array: ApplicationStack[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ApplicationStack[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ApplicationStack | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ApplicationStack

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ApplicationStack, index: number, obj: ApplicationStack[]): boolean
        • Parameters

          • this: void
          • value: ApplicationStack
          • index: number
          • obj: ApplicationStack[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ApplicationStack, index: number, obj: ApplicationStack[]): boolean
        • Parameters

          • value: ApplicationStack
          • index: number
          • obj: ApplicationStack[]

          Returns boolean

    • Optional thisArg: any

    Returns ApplicationStack | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ApplicationStack, index: number, obj: ApplicationStack[]): boolean
        • Parameters

          • value: ApplicationStack
          • index: number
          • obj: ApplicationStack[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ApplicationStack, index: number, array: ApplicationStack[]): void
        • Parameters

          • value: ApplicationStack
          • index: number
          • array: ApplicationStack[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ApplicationStack, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ApplicationStack

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ApplicationStack, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ApplicationStack

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ApplicationStack, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ApplicationStack

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ApplicationStack, index: number, array: ApplicationStack[]): U
        • Parameters

          • value: ApplicationStack
          • index: number
          • array: ApplicationStack[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ApplicationStack | undefined
  • Removes the last element from an array and returns it.

    Returns ApplicationStack | undefined

push

  • push(...items: ApplicationStack[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ApplicationStack[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ApplicationStack
  • reduce(callbackfn: function, initialValue: ApplicationStack): ApplicationStack
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ApplicationStack, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): ApplicationStack
        • Parameters

          • previousValue: ApplicationStack
          • currentValue: ApplicationStack
          • currentIndex: number
          • array: ApplicationStack[]

          Returns ApplicationStack

    Returns ApplicationStack

  • Parameters

    • callbackfn: function
        • (previousValue: ApplicationStack, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): ApplicationStack
        • Parameters

          • previousValue: ApplicationStack
          • currentValue: ApplicationStack
          • currentIndex: number
          • array: ApplicationStack[]

          Returns ApplicationStack

    • initialValue: ApplicationStack

    Returns ApplicationStack

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): U
        • Parameters

          • previousValue: U
          • currentValue: ApplicationStack
          • currentIndex: number
          • array: ApplicationStack[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ApplicationStack
  • reduceRight(callbackfn: function, initialValue: ApplicationStack): ApplicationStack
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ApplicationStack, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): ApplicationStack
        • Parameters

          • previousValue: ApplicationStack
          • currentValue: ApplicationStack
          • currentIndex: number
          • array: ApplicationStack[]

          Returns ApplicationStack

    Returns ApplicationStack

  • Parameters

    • callbackfn: function
        • (previousValue: ApplicationStack, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): ApplicationStack
        • Parameters

          • previousValue: ApplicationStack
          • currentValue: ApplicationStack
          • currentIndex: number
          • array: ApplicationStack[]

          Returns ApplicationStack

    • initialValue: ApplicationStack

    Returns ApplicationStack

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): U
        • Parameters

          • previousValue: U
          • currentValue: ApplicationStack
          • currentIndex: number
          • array: ApplicationStack[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ApplicationStack[]
  • Reverses the elements in an Array.

    Returns ApplicationStack[]

shift

  • shift(): ApplicationStack | undefined
  • Removes the first element from an array and returns it.

    Returns ApplicationStack | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ApplicationStack[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ApplicationStack[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ApplicationStack, index: number, array: ApplicationStack[]): boolean
        • Parameters

          • value: ApplicationStack
          • index: number
          • array: ApplicationStack[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ApplicationStack[]
  • splice(start: number, deleteCount: number, ...items: ApplicationStack[]): ApplicationStack[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ApplicationStack[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ApplicationStack[]

      Elements to insert into the array in place of the deleted elements.

    Returns ApplicationStack[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ApplicationStack[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ApplicationStack[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ApplicationStack>
  • Returns an iterable of values in the array

    Returns IterableIterator<ApplicationStack>

type

type: object

className

className: string = "ApplicationStackCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ApplicationStack"

name

name: "Composite" = "Composite"

Const AutoHealActions

AutoHealActions: object

Actions which to take by the auto-heal module when a rule is triggered.

Optional actionType

actionType: AutoHealActionType

Predefined action to be taken. Possible values include: 'Recycle', 'LogEvent', 'CustomAction'

Optional customAction

customAction: AutoHealCustomAction

Custom action to be taken.

Optional minProcessExecutionTime

minProcessExecutionTime: undefined | string

Minimum time the process must execute before taking the action

serializedName

serializedName: string = "AutoHealActions"

type

type: object

className

className: string = "AutoHealActions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionType

actionType: object

serializedName

serializedName: string = "actionType"

type

type: object

allowedValues

allowedValues: string[] = ["Recycle","LogEvent","CustomAction"]

name

name: "Enum" = "Enum"

customAction

customAction: object

serializedName

serializedName: string = "customAction"

type

type: object

className

className: string = "AutoHealCustomAction"

name

name: "Composite" = "Composite"

minProcessExecutionTime

minProcessExecutionTime: object

serializedName

serializedName: string = "minProcessExecutionTime"

type

type: object

name

name: "String" = "String"

Const AutoHealCustomAction

AutoHealCustomAction: object

Custom action to be executed when an auto heal rule is triggered.

Optional exe

exe: undefined | string

Executable to be run.

Optional parameters

parameters: undefined | string

Parameters for the executable.

serializedName

serializedName: string = "AutoHealCustomAction"

type

type: object

className

className: string = "AutoHealCustomAction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

exe

exe: object

serializedName

serializedName: string = "exe"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "String" = "String"

Const AutoHealRules

AutoHealRules: object

Rules that can be defined for auto-heal.

Optional actions

Actions to be executed when a rule is triggered.

serializedName

serializedName: string = "AutoHealRules"

Optional triggers

Conditions that describe when to execute the auto-heal actions.

type

type: object

className

className: string = "AutoHealRules"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actions

actions: object

serializedName

serializedName: string = "actions"

type

type: object

className

className: string = "AutoHealActions"

name

name: "Composite" = "Composite"

triggers

triggers: object

serializedName

serializedName: string = "triggers"

type

type: object

className

className: string = "AutoHealTriggers"

name

name: "Composite" = "Composite"

Const AutoHealTriggers

AutoHealTriggers: object

Triggers for auto-heal.

Optional privateBytesInKB

privateBytesInKB: undefined | number

A rule based on private bytes.

Optional requests

A rule based on total requests.

serializedName

serializedName: string = "AutoHealTriggers"

Optional slowRequests

A rule based on request execution time.

Optional statusCodes

statusCodes: StatusCodesBasedTrigger[]

A rule based on status codes.

type

type: object

className

className: string = "AutoHealTriggers"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

privateBytesInKB

privateBytesInKB: object

serializedName

serializedName: string = "privateBytesInKB"

type

type: object

name

name: "Number" = "Number"

requests

requests: object

serializedName

serializedName: string = "requests"

type

type: object

className

className: string = "RequestsBasedTrigger"

name

name: "Composite" = "Composite"

slowRequests

slowRequests: object

serializedName

serializedName: string = "slowRequests"

type

type: object

className

className: string = "SlowRequestsBasedTrigger"

name

name: "Composite" = "Composite"

statusCodes

statusCodes: object

serializedName

serializedName: string = "statusCodes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StatusCodesBasedTrigger"

name

name: "Composite" = "Composite"

Const AzureBlobStorageApplicationLogsConfig

AzureBlobStorageApplicationLogsConfig: object

Application logs azure blob storage configuration.

Optional level

level: LogLevel

Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'

Optional retentionInDays

retentionInDays: undefined | number

Retention in days. Remove blobs older than X days. 0 or lower means no retention.

Optional sasUrl

sasUrl: undefined | string

SAS url to a azure blob container with read/write/list/delete permissions.

serializedName

serializedName: string = "AzureBlobStorageApplicationLogsConfig"

type

type: object

className

className: string = "AzureBlobStorageApplicationLogsConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

level

level: object

serializedName

serializedName: string = "level"

type

type: object

allowedValues

allowedValues: string[] = ["Off","Verbose","Information","Warning","Error"]

name

name: "Enum" = "Enum"

retentionInDays

retentionInDays: object

serializedName

serializedName: string = "retentionInDays"

type

type: object

name

name: "Number" = "Number"

sasUrl

sasUrl: object

serializedName

serializedName: string = "sasUrl"

type

type: object

name

name: "String" = "String"

Const AzureBlobStorageHttpLogsConfig

AzureBlobStorageHttpLogsConfig: object

Http logs to azure blob storage configuration.

Optional enabled

enabled: undefined | false | true

True if configuration is enabled, false if it is disabled and null if configuration is not set.

Optional retentionInDays

retentionInDays: undefined | number

Retention in days. Remove blobs older than X days. 0 or lower means no retention.

Optional sasUrl

sasUrl: undefined | string

SAS url to a azure blob container with read/write/list/delete permissions.

serializedName

serializedName: string = "AzureBlobStorageHttpLogsConfig"

type

type: object

className

className: string = "AzureBlobStorageHttpLogsConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

retentionInDays

retentionInDays: object

serializedName

serializedName: string = "retentionInDays"

type

type: object

name

name: "Number" = "Number"

sasUrl

sasUrl: object

serializedName

serializedName: string = "sasUrl"

type

type: object

name

name: "String" = "String"

Const AzureStorageInfoValue

AzureStorageInfoValue: object

Azure Files or Blob Storage access information value for dictionary storage.

Optional accessKey

accessKey: undefined | string

Access key for the storage account.

Optional accountName

accountName: undefined | string

Name of the storage account.

Optional mountPath

mountPath: undefined | string

Path to mount the storage within the site's runtime environment.

serializedName

serializedName: string = "AzureStorageInfoValue"

Optional shareName

shareName: undefined | string

Name of the file share (container name, for Blob storage).

Optional state

State of the storage account. Possible values include: 'Ok', 'InvalidCredentials', 'InvalidShare' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

Type of storage. Possible values include: 'AzureFiles', 'AzureBlob'

className

className: string = "AzureStorageInfoValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessKey

accessKey: object

serializedName

serializedName: string = "accessKey"

type

type: object

name

name: "String" = "String"

accountName

accountName: object

serializedName

serializedName: string = "accountName"

type

type: object

name

name: "String" = "String"

mountPath

mountPath: object

serializedName

serializedName: string = "mountPath"

type

type: object

name

name: "String" = "String"

shareName

shareName: object

serializedName

serializedName: string = "shareName"

type

type: object

name

name: "String" = "String"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "state"

type

type: object

allowedValues

allowedValues: string[] = ["Ok","InvalidCredentials","InvalidShare"]

name

name: "Enum" = "Enum"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["AzureFiles","AzureBlob"]

name

name: "Enum" = "Enum"

Const AzureStoragePropertyDictionaryResource

AzureStoragePropertyDictionaryResource: object

AzureStorageInfo dictionary resource.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

Azure storage accounts.

serializedName

serializedName: string = "AzureStoragePropertyDictionaryResource"

type

type: object

className

className: string = "AzureStoragePropertyDictionaryResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "AzureStorageInfoValue"

name

name: "Composite" = "Composite"

Const AzureTableStorageApplicationLogsConfig

AzureTableStorageApplicationLogsConfig: object

Application logs to Azure table storage configuration.

Optional level

level: LogLevel

Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'

sasUrl

sasUrl: string

SAS URL to an Azure table with add/query/delete permissions.

serializedName

serializedName: string = "AzureTableStorageApplicationLogsConfig"

type

type: object

className

className: string = "AzureTableStorageApplicationLogsConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

level

level: object

serializedName

serializedName: string = "level"

type

type: object

allowedValues

allowedValues: string[] = ["Off","Verbose","Information","Warning","Error"]

name

name: "Enum" = "Enum"

sasUrl

sasUrl: object

required

required: true = true

serializedName

serializedName: string = "sasUrl"

type

type: object

name

name: "String" = "String"

Const BackupItem

BackupItem: object

Backup description.

Optional backupId

backupId: undefined | number

Id of the backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional backupItemName

backupItemName: undefined | string

Name of this backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional blobName

blobName: undefined | string

Name of the blob which contains data for this backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional correlationId

correlationId: undefined | string

Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. NOTE: This property will not be serialized. It can only be populated by the server.

Optional created

created: Date

Timestamp of the backup creation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databases

databases: DatabaseBackupSetting[]

List of databases included in the backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional finishedTimeStamp

finishedTimeStamp: Date

Timestamp when this backup finished. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional lastRestoreTimeStamp

lastRestoreTimeStamp: Date

Timestamp of a last restore operation which used this backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional log

log: undefined | string

Details regarding this backup. Might contain an error message. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scheduled

scheduled: undefined | false | true

True if this backup has been created due to a schedule being triggered. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackupItem"

Optional sizeInBytes

sizeInBytes: undefined | number

Size of the backup in bytes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

Backup status. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created', 'Skipped', 'PartiallySucceeded', 'DeleteInProgress', 'DeleteFailed', 'Deleted' NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageAccountUrl

storageAccountUrl: undefined | string

SAS URL for the storage account container which contains this backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional websiteSizeInBytes

websiteSizeInBytes: undefined | number

Size of the original web app which has been backed up. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "BackupItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupId

backupId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.id"

type

type: object

name

name: "Number" = "Number"

backupItemName

backupItemName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.name"

type

type: object

name

name: "String" = "String"

blobName

blobName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.blobName"

type

type: object

name

name: "String" = "String"

correlationId

correlationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.correlationId"

type

type: object

name

name: "String" = "String"

created

created: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.created"

type

type: object

name

name: "DateTime" = "DateTime"

databases

databases: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databases"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatabaseBackupSetting"

name

name: "Composite" = "Composite"

finishedTimeStamp

finishedTimeStamp: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.finishedTimeStamp"

type

type: object

name

name: "DateTime" = "DateTime"

lastRestoreTimeStamp

lastRestoreTimeStamp: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastRestoreTimeStamp"

type

type: object

name

name: "DateTime" = "DateTime"

log

log: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.log"

type

type: object

name

name: "String" = "String"

scheduled

scheduled: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.scheduled"

type

type: object

name

name: "Boolean" = "Boolean"

sizeInBytes

sizeInBytes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.sizeInBytes"

type

type: object

name

name: "Number" = "Number"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["InProgress","Failed","Succeeded","TimedOut","Created","Skipped","PartiallySucceeded","DeleteInProgress","DeleteFailed","Deleted"]

name

name: "Enum" = "Enum"

storageAccountUrl

storageAccountUrl: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.storageAccountUrl"

type

type: object

name

name: "String" = "String"

websiteSizeInBytes

websiteSizeInBytes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.websiteSizeInBytes"

type

type: object

name

name: "Number" = "Number"

Const BackupItemCollection

BackupItemCollection: object
interface

Collection of backup items.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackupItemCollection"

__@iterator

  • __@iterator(): IterableIterator<BackupItem>
  • Iterator

    Returns IterableIterator<BackupItem>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BackupItem>[]): BackupItem[]
  • concat(...items: (T | ConcatArray<T>)[]): BackupItem[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BackupItem>[]

      Additional items to add to the end of array1.

    Returns BackupItem[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BackupItem[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BackupItem]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BackupItem]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BackupItem, index: number, array: BackupItem[]): boolean
        • Parameters

          • value: BackupItem
          • index: number
          • array: BackupItem[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BackupItem, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BackupItem

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BackupItem[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BackupItem

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupItem, index: number, array: BackupItem[]): boolean
        • Parameters

          • value: BackupItem
          • index: number
          • array: BackupItem[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BackupItem, index: number, array: BackupItem[]): any
        • Parameters

          • value: BackupItem
          • index: number
          • array: BackupItem[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BackupItem[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BackupItem | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BackupItem

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BackupItem, index: number, obj: BackupItem[]): boolean
        • Parameters

          • this: void
          • value: BackupItem
          • index: number
          • obj: BackupItem[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BackupItem, index: number, obj: BackupItem[]): boolean
        • Parameters

          • value: BackupItem
          • index: number
          • obj: BackupItem[]

          Returns boolean

    • Optional thisArg: any

    Returns BackupItem | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BackupItem, index: number, obj: BackupItem[]): boolean
        • Parameters

          • value: BackupItem
          • index: number
          • obj: BackupItem[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BackupItem, index: number, array: BackupItem[]): void
        • Parameters

          • value: BackupItem
          • index: number
          • array: BackupItem[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BackupItem, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BackupItem

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BackupItem, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BackupItem

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BackupItem, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BackupItem

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BackupItem, index: number, array: BackupItem[]): U
        • Parameters

          • value: BackupItem
          • index: number
          • array: BackupItem[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BackupItem | undefined
  • Removes the last element from an array and returns it.

    Returns BackupItem | undefined

push

  • push(...items: BackupItem[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BackupItem[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BackupItem
  • reduce(callbackfn: function, initialValue: BackupItem): BackupItem
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupItem, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): BackupItem
        • Parameters

          • previousValue: BackupItem
          • currentValue: BackupItem
          • currentIndex: number
          • array: BackupItem[]

          Returns BackupItem

    Returns BackupItem

  • Parameters

    • callbackfn: function
        • (previousValue: BackupItem, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): BackupItem
        • Parameters

          • previousValue: BackupItem
          • currentValue: BackupItem
          • currentIndex: number
          • array: BackupItem[]

          Returns BackupItem

    • initialValue: BackupItem

    Returns BackupItem

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackupItem
          • currentIndex: number
          • array: BackupItem[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BackupItem
  • reduceRight(callbackfn: function, initialValue: BackupItem): BackupItem
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BackupItem, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): BackupItem
        • Parameters

          • previousValue: BackupItem
          • currentValue: BackupItem
          • currentIndex: number
          • array: BackupItem[]

          Returns BackupItem

    Returns BackupItem

  • Parameters

    • callbackfn: function
        • (previousValue: BackupItem, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): BackupItem
        • Parameters

          • previousValue: BackupItem
          • currentValue: BackupItem
          • currentIndex: number
          • array: BackupItem[]

          Returns BackupItem

    • initialValue: BackupItem

    Returns BackupItem

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): U
        • Parameters

          • previousValue: U
          • currentValue: BackupItem
          • currentIndex: number
          • array: BackupItem[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BackupItem[]
  • Reverses the elements in an Array.

    Returns BackupItem[]

shift

  • shift(): BackupItem | undefined
  • Removes the first element from an array and returns it.

    Returns BackupItem | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BackupItem[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BackupItem[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BackupItem, index: number, array: BackupItem[]): boolean
        • Parameters

          • value: BackupItem
          • index: number
          • array: BackupItem[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BackupItem[]
  • splice(start: number, deleteCount: number, ...items: BackupItem[]): BackupItem[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BackupItem[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BackupItem[]

      Elements to insert into the array in place of the deleted elements.

    Returns BackupItem[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BackupItem[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BackupItem[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BackupItem>
  • Returns an iterable of values in the array

    Returns IterableIterator<BackupItem>

type

type: object

className

className: string = "BackupItemCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BackupItem"

name

name: "Composite" = "Composite"

Const BackupRequest

BackupRequest: object

Description of a backup which will be performed.

Optional backupName

backupName: undefined | string

Name of the backup.

Optional backupSchedule

backupSchedule: BackupSchedule

Schedule for the backup if it is executed periodically.

Optional databases

databases: DatabaseBackupSetting[]

Databases included in the backup.

Optional enabled

enabled: undefined | false | true

True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackupRequest"

storageAccountUrl

storageAccountUrl: string

SAS URL to the container.

type

type: object

className

className: string = "BackupRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

backupName

backupName: object

serializedName

serializedName: string = "properties.backupName"

type

type: object

name

name: "String" = "String"

backupSchedule

backupSchedule: object

serializedName

serializedName: string = "properties.backupSchedule"

type

type: object

className

className: string = "BackupSchedule"

name

name: "Composite" = "Composite"

databases

databases: object

serializedName

serializedName: string = "properties.databases"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatabaseBackupSetting"

name

name: "Composite" = "Composite"

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

storageAccountUrl

storageAccountUrl: object

required

required: true = true

serializedName

serializedName: string = "properties.storageAccountUrl"

type

type: object

name

name: "String" = "String"

Const BackupSchedule

BackupSchedule: object

Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.

frequencyInterval

frequencyInterval: number

How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day). Default value: 7.

frequencyUnit

frequencyUnit: FrequencyUnit

The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7). Possible values include: 'Day', 'Hour'. Default value: 'Day'.

keepAtLeastOneBackup

keepAtLeastOneBackup: boolean

True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. Default value: true.

Optional lastExecutionTime

lastExecutionTime: Date

Last time when this schedule was triggered. NOTE: This property will not be serialized. It can only be populated by the server.

retentionPeriodInDays

retentionPeriodInDays: number

After how many days backups should be deleted. Default value: 30.

serializedName

serializedName: string = "BackupSchedule"

Optional startTime

startTime: Date

When the schedule should start working.

type

type: object

className

className: string = "BackupSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

frequencyInterval

frequencyInterval: object

defaultValue

defaultValue: number = 7

required

required: true = true

serializedName

serializedName: string = "frequencyInterval"

type

type: object

name

name: "Number" = "Number"

frequencyUnit

frequencyUnit: object

defaultValue

defaultValue: string = "Day"

required

required: true = true

serializedName

serializedName: string = "frequencyUnit"

type

type: object

allowedValues

allowedValues: string[] = ["Day","Hour"]

name

name: "Enum" = "Enum"

keepAtLeastOneBackup

keepAtLeastOneBackup: object

defaultValue

defaultValue: boolean = true

required

required: true = true

serializedName

serializedName: string = "keepAtLeastOneBackup"

type

type: object

name

name: "Boolean" = "Boolean"

lastExecutionTime

lastExecutionTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "lastExecutionTime"

type

type: object

name

name: "DateTime" = "DateTime"

retentionPeriodInDays

retentionPeriodInDays: object

defaultValue

defaultValue: number = 30

required

required: true = true

serializedName

serializedName: string = "retentionPeriodInDays"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const BillingMeter

BillingMeter: object

App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services.

Optional billingLocation

billingLocation: undefined | string

Azure Location of billable resource

Optional friendlyName

friendlyName: undefined | string

Friendly name of the meter

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional meterId

meterId: undefined | string

Meter GUID onboarded in Commerce

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional osType

osType: undefined | string

App Service OS type meter used for

Optional resourceType

resourceType: undefined | string

App Service ResourceType meter used for

serializedName

serializedName: string = "BillingMeter"

Optional shortName

shortName: undefined | string

Short Name from App Service Azure pricing Page

type

type: object

className

className: string = "BillingMeter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

billingLocation

billingLocation: object

serializedName

serializedName: string = "properties.billingLocation"

type

type: object

name

name: "String" = "String"

friendlyName

friendlyName: object

serializedName

serializedName: string = "properties.friendlyName"

type

type: object

name

name: "String" = "String"

meterId

meterId: object

serializedName

serializedName: string = "properties.meterId"

type

type: object

name

name: "String" = "String"

osType

osType: object

serializedName

serializedName: string = "properties.osType"

type

type: object

name

name: "String" = "String"

resourceType

resourceType: object

serializedName

serializedName: string = "properties.resourceType"

type

type: object

name

name: "String" = "String"

shortName

shortName: object

serializedName

serializedName: string = "properties.shortName"

type

type: object

name

name: "String" = "String"

Const BillingMeterCollection

BillingMeterCollection: object
interface

Collection of Billing Meters

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BillingMeterCollection"

__@iterator

  • __@iterator(): IterableIterator<BillingMeter>
  • Iterator

    Returns IterableIterator<BillingMeter>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<BillingMeter>[]): BillingMeter[]
  • concat(...items: (T | ConcatArray<T>)[]): BillingMeter[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BillingMeter>[]

      Additional items to add to the end of array1.

    Returns BillingMeter[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BillingMeter[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, BillingMeter]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BillingMeter]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: BillingMeter, index: number, array: BillingMeter[]): boolean
        • Parameters

          • value: BillingMeter
          • index: number
          • array: BillingMeter[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BillingMeter, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BillingMeter

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BillingMeter[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: BillingMeter

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BillingMeter, index: number, array: BillingMeter[]): boolean
        • Parameters

          • value: BillingMeter
          • index: number
          • array: BillingMeter[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: BillingMeter, index: number, array: BillingMeter[]): any
        • Parameters

          • value: BillingMeter
          • index: number
          • array: BillingMeter[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BillingMeter[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BillingMeter | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: BillingMeter

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: BillingMeter, index: number, obj: BillingMeter[]): boolean
        • Parameters

          • this: void
          • value: BillingMeter
          • index: number
          • obj: BillingMeter[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: BillingMeter, index: number, obj: BillingMeter[]): boolean
        • Parameters

          • value: BillingMeter
          • index: number
          • obj: BillingMeter[]

          Returns boolean

    • Optional thisArg: any

    Returns BillingMeter | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: BillingMeter, index: number, obj: BillingMeter[]): boolean
        • Parameters

          • value: BillingMeter
          • index: number
          • obj: BillingMeter[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: BillingMeter, index: number, array: BillingMeter[]): void
        • Parameters

          • value: BillingMeter
          • index: number
          • array: BillingMeter[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: BillingMeter, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BillingMeter

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: BillingMeter, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BillingMeter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: BillingMeter, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BillingMeter

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: BillingMeter, index: number, array: BillingMeter[]): U
        • Parameters

          • value: BillingMeter
          • index: number
          • array: BillingMeter[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): BillingMeter | undefined
  • Removes the last element from an array and returns it.

    Returns BillingMeter | undefined

push

  • push(...items: BillingMeter[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: BillingMeter[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): BillingMeter
  • reduce(callbackfn: function, initialValue: BillingMeter): BillingMeter
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: BillingMeter, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): BillingMeter
        • Parameters

          • previousValue: BillingMeter
          • currentValue: BillingMeter
          • currentIndex: number
          • array: BillingMeter[]

          Returns BillingMeter

    Returns BillingMeter

  • Parameters

    • callbackfn: function
        • (previousValue: BillingMeter, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): BillingMeter
        • Parameters

          • previousValue: BillingMeter
          • currentValue: BillingMeter
          • currentIndex: number
          • array: BillingMeter[]

          Returns BillingMeter

    • initialValue: BillingMeter

    Returns BillingMeter

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): U
        • Parameters

          • previousValue: U
          • currentValue: BillingMeter
          • currentIndex: number
          • array: BillingMeter[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): BillingMeter
  • reduceRight(callbackfn: function, initialValue: BillingMeter): BillingMeter
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: BillingMeter, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): BillingMeter
        • Parameters

          • previousValue: BillingMeter
          • currentValue: BillingMeter
          • currentIndex: number
          • array: BillingMeter[]

          Returns BillingMeter

    Returns BillingMeter

  • Parameters

    • callbackfn: function
        • (previousValue: BillingMeter, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): BillingMeter
        • Parameters

          • previousValue: BillingMeter
          • currentValue: BillingMeter
          • currentIndex: number
          • array: BillingMeter[]

          Returns BillingMeter

    • initialValue: BillingMeter

    Returns BillingMeter

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): U
        • Parameters

          • previousValue: U
          • currentValue: BillingMeter
          • currentIndex: number
          • array: BillingMeter[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): BillingMeter[]
  • Reverses the elements in an Array.

    Returns BillingMeter[]

shift

  • shift(): BillingMeter | undefined
  • Removes the first element from an array and returns it.

    Returns BillingMeter | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): BillingMeter[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BillingMeter[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: BillingMeter, index: number, array: BillingMeter[]): boolean
        • Parameters

          • value: BillingMeter
          • index: number
          • array: BillingMeter[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): BillingMeter[]
  • splice(start: number, deleteCount: number, ...items: BillingMeter[]): BillingMeter[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BillingMeter[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BillingMeter[]

      Elements to insert into the array in place of the deleted elements.

    Returns BillingMeter[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: BillingMeter[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: BillingMeter[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<BillingMeter>
  • Returns an iterable of values in the array

    Returns IterableIterator<BillingMeter>

type

type: object

className

className: string = "BillingMeterCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BillingMeter"

name

name: "Composite" = "Composite"

Const Capability

Capability: object

Describes the capabilities/features allowed for a specific SKU.

Optional name

name: undefined | string

Name of the SKU capability.

Optional reason

reason: undefined | string

Reason of the SKU capability.

serializedName

serializedName: string = "Capability"

Optional value

value: undefined | string

Value of the SKU capability.

type

type: object

className

className: string = "Capability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const Certificate

Certificate: object

SSL certificate for an app.

Optional cerBlob

cerBlob: Uint8Array

Raw bytes of .cer file NOTE: This property will not be serialized. It can only be populated by the server.

Optional expirationDate

expirationDate: Date

Certificate expiration date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional friendlyName

friendlyName: undefined | string

Friendly name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNames

hostNames: string[]

Host names the certificate applies to.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

Specification for the App Service Environment to use for the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issueDate

issueDate: Date

Certificate issue Date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issuer

issuer: undefined | string

Certificate issuer. NOTE: This property will not be serialized. It can only be populated by the server.

Optional keyVaultId

keyVaultId: undefined | string

Key Vault Csm resource Id.

Optional keyVaultSecretName

keyVaultSecretName: undefined | string

Key Vault secret name.

Optional keyVaultSecretStatus

keyVaultSecretStatus: KeyVaultSecretStatus

Status of the Key Vault secret. Possible values include: 'Initialized', 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

location

location: string

Resource Location.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

password

password: string

Certificate password.

Optional pfxBlob

pfxBlob: Uint8Array

Pfx blob.

Optional publicKeyHash

publicKeyHash: undefined | string

Public key hash. NOTE: This property will not be serialized. It can only be populated by the server.

Optional selfLink

selfLink: undefined | string

Self link. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Certificate"

Optional serverFarmId

serverFarmId: undefined | string

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Optional siteName

siteName: undefined | string

App name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subjectName

subjectName: undefined | string

Subject name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

Optional thumbprint

thumbprint: undefined | string

Certificate thumbprint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional valid

valid: undefined | false | true

Is the certificate valid?. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Certificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cerBlob

cerBlob: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.cerBlob"

type

type: object

name

name: "ByteArray" = "ByteArray"

expirationDate

expirationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

friendlyName

friendlyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.friendlyName"

type

type: object

name

name: "String" = "String"

hostNames

hostNames: object

serializedName

serializedName: string = "properties.hostNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

hostingEnvironmentProfile

hostingEnvironmentProfile: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hostingEnvironmentProfile"

type

type: object

className

className: string = "HostingEnvironmentProfile"

name

name: "Composite" = "Composite"

issueDate

issueDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.issueDate"

type

type: object

name

name: "DateTime" = "DateTime"

issuer

issuer: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.issuer"

type

type: object

name

name: "String" = "String"

keyVaultId

keyVaultId: object

serializedName

serializedName: string = "properties.keyVaultId"

type

type: object

name

name: "String" = "String"

keyVaultSecretName

keyVaultSecretName: object

serializedName

serializedName: string = "properties.keyVaultSecretName"

type

type: object

name

name: "String" = "String"

keyVaultSecretStatus

keyVaultSecretStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.keyVaultSecretStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Initialized","WaitingOnCertificateOrder","Succeeded","CertificateOrderFailed","OperationNotPermittedOnKeyVault","AzureServiceUnauthorizedToAccessKeyVault","KeyVaultDoesNotExist","KeyVaultSecretDoesNotExist","UnknownError","ExternalPrivateKey","Unknown"]

name

name: "Enum" = "Enum"

password

password: object

required

required: true = true

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

pfxBlob

pfxBlob: object

serializedName

serializedName: string = "properties.pfxBlob"

type

type: object

name

name: "ByteArray" = "ByteArray"

publicKeyHash

publicKeyHash: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.publicKeyHash"

type

type: object

name

name: "String" = "String"

selfLink

selfLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.selfLink"

type

type: object

name

name: "String" = "String"

serverFarmId

serverFarmId: object

serializedName

serializedName: string = "properties.serverFarmId"

type

type: object

name

name: "String" = "String"

siteName

siteName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.siteName"

type

type: object

name

name: "String" = "String"

subjectName

subjectName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subjectName"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

valid

valid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.valid"

type

type: object

name

name: "Boolean" = "Boolean"

Const CertificateCollection

CertificateCollection: object
interface

Collection of certificates.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CertificateCollection"

__@iterator

  • __@iterator(): IterableIterator<Certificate>
  • Iterator

    Returns IterableIterator<Certificate>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Certificate>[]): Certificate[]
  • concat(...items: (T | ConcatArray<T>)[]): Certificate[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Certificate>[]

      Additional items to add to the end of array1.

    Returns Certificate[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Certificate[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Certificate]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Certificate]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Certificate, index: number, array: Certificate[]): boolean
        • Parameters

          • value: Certificate
          • index: number
          • array: Certificate[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Certificate, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Certificate

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Certificate[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Certificate

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Certificate, index: number, array: Certificate[]): boolean
        • Parameters

          • value: Certificate
          • index: number
          • array: Certificate[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Certificate, index: number, array: Certificate[]): any
        • Parameters

          • value: Certificate
          • index: number
          • array: Certificate[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Certificate[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Certificate | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Certificate

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Certificate, index: number, obj: Certificate[]): boolean
        • Parameters

          • this: void
          • value: Certificate
          • index: number
          • obj: Certificate[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Certificate, index: number, obj: Certificate[]): boolean
        • Parameters

          • value: Certificate
          • index: number
          • obj: Certificate[]

          Returns boolean

    • Optional thisArg: any

    Returns Certificate | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Certificate, index: number, obj: Certificate[]): boolean
        • Parameters

          • value: Certificate
          • index: number
          • obj: Certificate[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Certificate, index: number, array: Certificate[]): void
        • Parameters

          • value: Certificate
          • index: number
          • array: Certificate[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Certificate, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Certificate

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Certificate, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Certificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Certificate, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Certificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Certificate, index: number, array: Certificate[]): U
        • Parameters

          • value: Certificate
          • index: number
          • array: Certificate[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Certificate | undefined
  • Removes the last element from an array and returns it.

    Returns Certificate | undefined

push

  • push(...items: Certificate[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Certificate[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Certificate
  • reduce(callbackfn: function, initialValue: Certificate): Certificate
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Certificate, currentValue: Certificate, currentIndex: number, array: Certificate[]): Certificate
        • Parameters

          • previousValue: Certificate
          • currentValue: Certificate
          • currentIndex: number
          • array: Certificate[]

          Returns Certificate

    Returns Certificate

  • Parameters

    • callbackfn: function
        • (previousValue: Certificate, currentValue: Certificate, currentIndex: number, array: Certificate[]): Certificate
        • Parameters

          • previousValue: Certificate
          • currentValue: Certificate
          • currentIndex: number
          • array: Certificate[]

          Returns Certificate

    • initialValue: Certificate

    Returns Certificate

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Certificate, currentIndex: number, array: Certificate[]): U
        • Parameters

          • previousValue: U
          • currentValue: Certificate
          • currentIndex: number
          • array: Certificate[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Certificate
  • reduceRight(callbackfn: function, initialValue: Certificate): Certificate
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Certificate, currentValue: Certificate, currentIndex: number, array: Certificate[]): Certificate
        • Parameters

          • previousValue: Certificate
          • currentValue: Certificate
          • currentIndex: number
          • array: Certificate[]

          Returns Certificate

    Returns Certificate

  • Parameters

    • callbackfn: function
        • (previousValue: Certificate, currentValue: Certificate, currentIndex: number, array: Certificate[]): Certificate
        • Parameters

          • previousValue: Certificate
          • currentValue: Certificate
          • currentIndex: number
          • array: Certificate[]

          Returns Certificate

    • initialValue: Certificate

    Returns Certificate

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Certificate, currentIndex: number, array: Certificate[]): U
        • Parameters

          • previousValue: U
          • currentValue: Certificate
          • currentIndex: number
          • array: Certificate[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Certificate[]
  • Reverses the elements in an Array.

    Returns Certificate[]

shift

  • shift(): Certificate | undefined
  • Removes the first element from an array and returns it.

    Returns Certificate | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Certificate[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Certificate[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Certificate, index: number, array: Certificate[]): boolean
        • Parameters

          • value: Certificate
          • index: number
          • array: Certificate[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Certificate[]
  • splice(start: number, deleteCount: number, ...items: Certificate[]): Certificate[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Certificate[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Certificate[]

      Elements to insert into the array in place of the deleted elements.

    Returns Certificate[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Certificate[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Certificate[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Certificate>
  • Returns an iterable of values in the array

    Returns IterableIterator<Certificate>

type

type: object

className

className: string = "CertificateCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Certificate"

name

name: "Composite" = "Composite"

Const CertificatePatchResource

CertificatePatchResource: object

ARM resource for a certificate.

Optional cerBlob

cerBlob: Uint8Array

Raw bytes of .cer file NOTE: This property will not be serialized. It can only be populated by the server.

Optional expirationDate

expirationDate: Date

Certificate expiration date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional friendlyName

friendlyName: undefined | string

Friendly name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNames

hostNames: string[]

Host names the certificate applies to.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

Specification for the App Service Environment to use for the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issueDate

issueDate: Date

Certificate issue Date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issuer

issuer: undefined | string

Certificate issuer. NOTE: This property will not be serialized. It can only be populated by the server.

Optional keyVaultId

keyVaultId: undefined | string

Key Vault Csm resource Id.

Optional keyVaultSecretName

keyVaultSecretName: undefined | string

Key Vault secret name.

Optional keyVaultSecretStatus

keyVaultSecretStatus: KeyVaultSecretStatus

Status of the Key Vault secret. Possible values include: 'Initialized', 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

password

password: string

Certificate password.

Optional pfxBlob

pfxBlob: Uint8Array

Pfx blob.

Optional publicKeyHash

publicKeyHash: undefined | string

Public key hash. NOTE: This property will not be serialized. It can only be populated by the server.

Optional selfLink

selfLink: undefined | string

Self link. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CertificatePatchResource"

Optional serverFarmId

serverFarmId: undefined | string

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Optional siteName

siteName: undefined | string

App name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subjectName

subjectName: undefined | string

Subject name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional thumbprint

thumbprint: undefined | string

Certificate thumbprint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional valid

valid: undefined | false | true

Is the certificate valid?. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "CertificatePatchResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

cerBlob

cerBlob: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.cerBlob"

type

type: object

name

name: "ByteArray" = "ByteArray"

expirationDate

expirationDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.expirationDate"

type

type: object

name

name: "DateTime" = "DateTime"

friendlyName

friendlyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.friendlyName"

type

type: object

name

name: "String" = "String"

hostNames

hostNames: object

serializedName

serializedName: string = "properties.hostNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

hostingEnvironmentProfile

hostingEnvironmentProfile: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hostingEnvironmentProfile"

type

type: object

className

className: string = "HostingEnvironmentProfile"

name

name: "Composite" = "Composite"

issueDate

issueDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.issueDate"

type

type: object

name

name: "DateTime" = "DateTime"

issuer

issuer: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.issuer"

type

type: object

name

name: "String" = "String"

keyVaultId

keyVaultId: object

serializedName

serializedName: string = "properties.keyVaultId"

type

type: object

name

name: "String" = "String"

keyVaultSecretName

keyVaultSecretName: object

serializedName

serializedName: string = "properties.keyVaultSecretName"

type

type: object

name

name: "String" = "String"

keyVaultSecretStatus

keyVaultSecretStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.keyVaultSecretStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Initialized","WaitingOnCertificateOrder","Succeeded","CertificateOrderFailed","OperationNotPermittedOnKeyVault","AzureServiceUnauthorizedToAccessKeyVault","KeyVaultDoesNotExist","KeyVaultSecretDoesNotExist","UnknownError","ExternalPrivateKey","Unknown"]

name

name: "Enum" = "Enum"

password

password: object

required

required: true = true

serializedName

serializedName: string = "properties.password"

type

type: object

name

name: "String" = "String"

pfxBlob

pfxBlob: object

serializedName

serializedName: string = "properties.pfxBlob"

type

type: object

name

name: "ByteArray" = "ByteArray"

publicKeyHash

publicKeyHash: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.publicKeyHash"

type

type: object

name

name: "String" = "String"

selfLink

selfLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.selfLink"

type

type: object

name

name: "String" = "String"

serverFarmId

serverFarmId: object

serializedName

serializedName: string = "properties.serverFarmId"

type

type: object

name

name: "String" = "String"

siteName

siteName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.siteName"

type

type: object

name

name: "String" = "String"

subjectName

subjectName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subjectName"

type

type: object

name

name: "String" = "String"

thumbprint

thumbprint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

valid

valid: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.valid"

type

type: object

name

name: "Boolean" = "Boolean"

Const CloningInfo

CloningInfo: object

Information needed for cloning operation.

Optional appSettingsOverrides

appSettingsOverrides: undefined | object

Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.

Optional cloneCustomHostNames

cloneCustomHostNames: undefined | false | true

true to clone custom hostnames from source app; otherwise, false.

Optional cloneSourceControl

cloneSourceControl: undefined | false | true

true to clone source control from source app; otherwise, false.

Optional configureLoadBalancing

configureLoadBalancing: undefined | false | true

true to configure load balancing for source and destination app.

Optional correlationId

correlationId: undefined | string

Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

Optional hostingEnvironment

hostingEnvironment: undefined | string

App Service Environment.

Optional overwrite

overwrite: undefined | false | true

true to overwrite destination app; otherwise, false.

serializedName

serializedName: string = "CloningInfo"

sourceWebAppId

sourceWebAppId: string

ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.

Optional sourceWebAppLocation

sourceWebAppLocation: undefined | string

Location of source app ex: West US or North Europe

Optional trafficManagerProfileId

trafficManagerProfileId: undefined | string

ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.

Optional trafficManagerProfileName

trafficManagerProfileName: undefined | string

Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

type

type: object

className

className: string = "CloningInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appSettingsOverrides

appSettingsOverrides: object

serializedName

serializedName: string = "appSettingsOverrides"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

cloneCustomHostNames

cloneCustomHostNames: object

serializedName

serializedName: string = "cloneCustomHostNames"

type

type: object

name

name: "Boolean" = "Boolean"

cloneSourceControl

cloneSourceControl: object

serializedName

serializedName: string = "cloneSourceControl"

type

type: object

name

name: "Boolean" = "Boolean"

configureLoadBalancing

configureLoadBalancing: object

serializedName

serializedName: string = "configureLoadBalancing"

type

type: object

name

name: "Boolean" = "Boolean"

correlationId

correlationId: object

serializedName

serializedName: string = "correlationId"

type

type: object

name

name: "Uuid" = "Uuid"

hostingEnvironment

hostingEnvironment: object

serializedName

serializedName: string = "hostingEnvironment"

type

type: object

name

name: "String" = "String"

overwrite

overwrite: object

serializedName

serializedName: string = "overwrite"

type

type: object

name

name: "Boolean" = "Boolean"

sourceWebAppId

sourceWebAppId: object

required

required: true = true

serializedName

serializedName: string = "sourceWebAppId"

type

type: object

name

name: "String" = "String"

sourceWebAppLocation

sourceWebAppLocation: object

serializedName

serializedName: string = "sourceWebAppLocation"

type

type: object

name

name: "String" = "String"

trafficManagerProfileId

trafficManagerProfileId: object

serializedName

serializedName: string = "trafficManagerProfileId"

type

type: object

name

name: "String" = "String"

trafficManagerProfileName

trafficManagerProfileName: object

serializedName

serializedName: string = "trafficManagerProfileName"

type

type: object

name

name: "String" = "String"

Const ConnStringInfo

ConnStringInfo: object

Database connection string information.

Optional connectionString

connectionString: undefined | string

Connection string value.

Optional name

name: undefined | string

Name of connection string.

serializedName

serializedName: string = "ConnStringInfo"

type

type: object

Type of database. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'

className

className: string = "ConnStringInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "connectionString"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["MySql","SQLServer","SQLAzure","Custom","NotificationHub","ServiceBus","EventHub","ApiHub","DocDb","RedisCache","PostgreSQL"]

name

name: "Enum" = "Enum"

Const ConnStringValueTypePair

ConnStringValueTypePair: object

Database connection string value to type pair.

serializedName

serializedName: string = "ConnStringValueTypePair"

value

value: string

Value of pair.

type

type: object

Type of database. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'

className

className: string = "ConnStringValueTypePair"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["MySql","SQLServer","SQLAzure","Custom","NotificationHub","ServiceBus","EventHub","ApiHub","DocDb","RedisCache","PostgreSQL"]

name

name: "Enum" = "Enum"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ConnectionStringDictionary

ConnectionStringDictionary: object

String dictionary resource.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

Connection strings.

serializedName

serializedName: string = "ConnectionStringDictionary"

type

type: object

className

className: string = "ConnectionStringDictionary"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "ConnStringValueTypePair"

name

name: "Composite" = "Composite"

Const ContinuousWebJob

ContinuousWebJob: object

Continuous Web Job Information.

Optional detailedStatus

detailedStatus: undefined | string

Detailed status.

Optional error

error: undefined | string

Error information.

Optional extraInfoUrl

extraInfoUrl: undefined | string

Extra Info URL.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional logUrl

logUrl: undefined | string

Log URL.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runCommand

runCommand: undefined | string

Run command.

serializedName

serializedName: string = "ContinuousWebJob"

Optional settings

settings: undefined | object

Job settings.

Optional status

Job status. Possible values include: 'Initializing', 'Starting', 'Running', 'PendingRestart', 'Stopped'

Optional url

url: undefined | string

Job URL.

Optional usingSdk

usingSdk: undefined | false | true

Using SDK?

Optional webJobType

webJobType: WebJobType

Job type. Possible values include: 'Continuous', 'Triggered'

type

type: object

className

className: string = "ContinuousWebJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

detailedStatus

detailedStatus: object

serializedName

serializedName: string = "properties.detailed_status"

type

type: object

name

name: "String" = "String"

error

error: object

serializedName

serializedName: string = "properties.error"

type

type: object

name

name: "String" = "String"

extraInfoUrl

extraInfoUrl: object

serializedName

serializedName: string = "properties.extra_info_url"

type

type: object

name

name: "String" = "String"

logUrl

logUrl: object

serializedName

serializedName: string = "properties.log_url"

type

type: object

name

name: "String" = "String"

runCommand

runCommand: object

serializedName

serializedName: string = "properties.run_command"

type

type: object

name

name: "String" = "String"

settings

settings: object

serializedName

serializedName: string = "properties.settings"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["Initializing","Starting","Running","PendingRestart","Stopped"]

name

name: "Enum" = "Enum"

url

url: object

serializedName

serializedName: string = "properties.url"

type

type: object

name

name: "String" = "String"

usingSdk

usingSdk: object

serializedName

serializedName: string = "properties.using_sdk"

type

type: object

name

name: "Boolean" = "Boolean"

webJobType

webJobType: object

serializedName

serializedName: string = "properties.web_job_type"

type

type: object

allowedValues

allowedValues: string[] = ["Continuous","Triggered"]

name

name: "Enum" = "Enum"

Const ContinuousWebJobCollection

ContinuousWebJobCollection: object
interface

Collection of Kudu continuous web job information elements.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ContinuousWebJobCollection"

__@iterator

  • __@iterator(): IterableIterator<ContinuousWebJob>
  • Iterator

    Returns IterableIterator<ContinuousWebJob>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ContinuousWebJob>[]): ContinuousWebJob[]
  • concat(...items: (T | ConcatArray<T>)[]): ContinuousWebJob[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ContinuousWebJob>[]

      Additional items to add to the end of array1.

    Returns ContinuousWebJob[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ContinuousWebJob[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ContinuousWebJob]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ContinuousWebJob]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): boolean
        • Parameters

          • value: ContinuousWebJob
          • index: number
          • array: ContinuousWebJob[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ContinuousWebJob, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ContinuousWebJob

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ContinuousWebJob[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ContinuousWebJob

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): boolean
        • Parameters

          • value: ContinuousWebJob
          • index: number
          • array: ContinuousWebJob[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): any
        • Parameters

          • value: ContinuousWebJob
          • index: number
          • array: ContinuousWebJob[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ContinuousWebJob[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ContinuousWebJob | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ContinuousWebJob

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ContinuousWebJob, index: number, obj: ContinuousWebJob[]): boolean
        • Parameters

          • this: void
          • value: ContinuousWebJob
          • index: number
          • obj: ContinuousWebJob[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ContinuousWebJob, index: number, obj: ContinuousWebJob[]): boolean
        • Parameters

          • value: ContinuousWebJob
          • index: number
          • obj: ContinuousWebJob[]

          Returns boolean

    • Optional thisArg: any

    Returns ContinuousWebJob | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ContinuousWebJob, index: number, obj: ContinuousWebJob[]): boolean
        • Parameters

          • value: ContinuousWebJob
          • index: number
          • obj: ContinuousWebJob[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): void
        • Parameters

          • value: ContinuousWebJob
          • index: number
          • array: ContinuousWebJob[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ContinuousWebJob, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ContinuousWebJob

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ContinuousWebJob, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ContinuousWebJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ContinuousWebJob, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ContinuousWebJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): U
        • Parameters

          • value: ContinuousWebJob
          • index: number
          • array: ContinuousWebJob[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ContinuousWebJob | undefined
  • Removes the last element from an array and returns it.

    Returns ContinuousWebJob | undefined

push

  • push(...items: ContinuousWebJob[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ContinuousWebJob[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ContinuousWebJob
  • reduce(callbackfn: function, initialValue: ContinuousWebJob): ContinuousWebJob
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ContinuousWebJob, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): ContinuousWebJob
        • Parameters

          • previousValue: ContinuousWebJob
          • currentValue: ContinuousWebJob
          • currentIndex: number
          • array: ContinuousWebJob[]

          Returns ContinuousWebJob

    Returns ContinuousWebJob

  • Parameters

    • callbackfn: function
        • (previousValue: ContinuousWebJob, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): ContinuousWebJob
        • Parameters

          • previousValue: ContinuousWebJob
          • currentValue: ContinuousWebJob
          • currentIndex: number
          • array: ContinuousWebJob[]

          Returns ContinuousWebJob

    • initialValue: ContinuousWebJob

    Returns ContinuousWebJob

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): U
        • Parameters

          • previousValue: U
          • currentValue: ContinuousWebJob
          • currentIndex: number
          • array: ContinuousWebJob[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ContinuousWebJob
  • reduceRight(callbackfn: function, initialValue: ContinuousWebJob): ContinuousWebJob
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ContinuousWebJob, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): ContinuousWebJob
        • Parameters

          • previousValue: ContinuousWebJob
          • currentValue: ContinuousWebJob
          • currentIndex: number
          • array: ContinuousWebJob[]

          Returns ContinuousWebJob

    Returns ContinuousWebJob

  • Parameters

    • callbackfn: function
        • (previousValue: ContinuousWebJob, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): ContinuousWebJob
        • Parameters

          • previousValue: ContinuousWebJob
          • currentValue: ContinuousWebJob
          • currentIndex: number
          • array: ContinuousWebJob[]

          Returns ContinuousWebJob

    • initialValue: ContinuousWebJob

    Returns ContinuousWebJob

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): U
        • Parameters

          • previousValue: U
          • currentValue: ContinuousWebJob
          • currentIndex: number
          • array: ContinuousWebJob[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ContinuousWebJob[]
  • Reverses the elements in an Array.

    Returns ContinuousWebJob[]

shift

  • shift(): ContinuousWebJob | undefined
  • Removes the first element from an array and returns it.

    Returns ContinuousWebJob | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ContinuousWebJob[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ContinuousWebJob[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): boolean
        • Parameters

          • value: ContinuousWebJob
          • index: number
          • array: ContinuousWebJob[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ContinuousWebJob[]
  • splice(start: number, deleteCount: number, ...items: ContinuousWebJob[]): ContinuousWebJob[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ContinuousWebJob[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ContinuousWebJob[]

      Elements to insert into the array in place of the deleted elements.

    Returns ContinuousWebJob[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ContinuousWebJob[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ContinuousWebJob[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ContinuousWebJob>
  • Returns an iterable of values in the array

    Returns IterableIterator<ContinuousWebJob>

type

type: object

className

className: string = "ContinuousWebJobCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ContinuousWebJob"

name

name: "Composite" = "Composite"

Const CorsSettings

CorsSettings: object

Cross-Origin Resource Sharing (CORS) settings for the app.

Optional allowedOrigins

allowedOrigins: string[]

Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all.

serializedName

serializedName: string = "CorsSettings"

Optional supportCredentials

supportCredentials: undefined | false | true

Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details.

type

type: object

className

className: string = "CorsSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowedOrigins

allowedOrigins: object

serializedName

serializedName: string = "allowedOrigins"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

supportCredentials

supportCredentials: object

serializedName

serializedName: string = "supportCredentials"

type

type: object

name

name: "Boolean" = "Boolean"

Const CsmMoveResourceEnvelope

CsmMoveResourceEnvelope: object

Object with a list of the resources that need to be moved and the resource group they should be moved to.

Optional resources

resources: string[]

serializedName

serializedName: string = "CsmMoveResourceEnvelope"

Optional targetResourceGroup

targetResourceGroup: undefined | string

type

type: object

className

className: string = "CsmMoveResourceEnvelope"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

resources

resources: object

serializedName

serializedName: string = "resources"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

targetResourceGroup

targetResourceGroup: object

serializedName

serializedName: string = "targetResourceGroup"

constraints

constraints: object

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = / ^[-\w\._\(\)]+[^\.]$/

type

type: object

name

name: "String" = "String"

Const CsmOperationCollection

CsmOperationCollection: object
interface

Collection of Azure resource manager operation metadata.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CsmOperationCollection"

__@iterator

  • __@iterator(): IterableIterator<CsmOperationDescription>
  • Iterator

    Returns IterableIterator<CsmOperationDescription>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<CsmOperationDescription>[]): CsmOperationDescription[]
  • concat(...items: (T | ConcatArray<T>)[]): CsmOperationDescription[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CsmOperationDescription>[]

      Additional items to add to the end of array1.

    Returns CsmOperationDescription[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CsmOperationDescription[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, CsmOperationDescription]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CsmOperationDescription]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): boolean
        • Parameters

          • value: CsmOperationDescription
          • index: number
          • array: CsmOperationDescription[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: CsmOperationDescription, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CsmOperationDescription

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CsmOperationDescription[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: CsmOperationDescription

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): boolean
        • Parameters

          • value: CsmOperationDescription
          • index: number
          • array: CsmOperationDescription[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): any
        • Parameters

          • value: CsmOperationDescription
          • index: number
          • array: CsmOperationDescription[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CsmOperationDescription[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CsmOperationDescription | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: CsmOperationDescription

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: CsmOperationDescription, index: number, obj: CsmOperationDescription[]): boolean
        • Parameters

          • this: void
          • value: CsmOperationDescription
          • index: number
          • obj: CsmOperationDescription[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: CsmOperationDescription, index: number, obj: CsmOperationDescription[]): boolean
        • Parameters

          • value: CsmOperationDescription
          • index: number
          • obj: CsmOperationDescription[]

          Returns boolean

    • Optional thisArg: any

    Returns CsmOperationDescription | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: CsmOperationDescription, index: number, obj: CsmOperationDescription[]): boolean
        • Parameters

          • value: CsmOperationDescription
          • index: number
          • obj: CsmOperationDescription[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): void
        • Parameters

          • value: CsmOperationDescription
          • index: number
          • array: CsmOperationDescription[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: CsmOperationDescription, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CsmOperationDescription

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: CsmOperationDescription, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CsmOperationDescription

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CsmOperationDescription, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CsmOperationDescription

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): U
        • Parameters

          • value: CsmOperationDescription
          • index: number
          • array: CsmOperationDescription[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): CsmOperationDescription | undefined
  • Removes the last element from an array and returns it.

    Returns CsmOperationDescription | undefined

push

  • push(...items: CsmOperationDescription[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: CsmOperationDescription[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): CsmOperationDescription
  • reduce(callbackfn: function, initialValue: CsmOperationDescription): CsmOperationDescription
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: CsmOperationDescription, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): CsmOperationDescription
        • Parameters

          • previousValue: CsmOperationDescription
          • currentValue: CsmOperationDescription
          • currentIndex: number
          • array: CsmOperationDescription[]

          Returns CsmOperationDescription

    Returns CsmOperationDescription

  • Parameters

    • callbackfn: function
        • (previousValue: CsmOperationDescription, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): CsmOperationDescription
        • Parameters

          • previousValue: CsmOperationDescription
          • currentValue: CsmOperationDescription
          • currentIndex: number
          • array: CsmOperationDescription[]

          Returns CsmOperationDescription

    • initialValue: CsmOperationDescription

    Returns CsmOperationDescription

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): U
        • Parameters

          • previousValue: U
          • currentValue: CsmOperationDescription
          • currentIndex: number
          • array: CsmOperationDescription[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): CsmOperationDescription
  • reduceRight(callbackfn: function, initialValue: CsmOperationDescription): CsmOperationDescription
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: CsmOperationDescription, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): CsmOperationDescription
        • Parameters

          • previousValue: CsmOperationDescription
          • currentValue: CsmOperationDescription
          • currentIndex: number
          • array: CsmOperationDescription[]

          Returns CsmOperationDescription

    Returns CsmOperationDescription

  • Parameters

    • callbackfn: function
        • (previousValue: CsmOperationDescription, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): CsmOperationDescription
        • Parameters

          • previousValue: CsmOperationDescription
          • currentValue: CsmOperationDescription
          • currentIndex: number
          • array: CsmOperationDescription[]

          Returns CsmOperationDescription

    • initialValue: CsmOperationDescription

    Returns CsmOperationDescription

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): U
        • Parameters

          • previousValue: U
          • currentValue: CsmOperationDescription
          • currentIndex: number
          • array: CsmOperationDescription[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): CsmOperationDescription[]
  • Reverses the elements in an Array.

    Returns CsmOperationDescription[]

shift

  • shift(): CsmOperationDescription | undefined
  • Removes the first element from an array and returns it.

    Returns CsmOperationDescription | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): CsmOperationDescription[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CsmOperationDescription[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): boolean
        • Parameters

          • value: CsmOperationDescription
          • index: number
          • array: CsmOperationDescription[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): CsmOperationDescription[]
  • splice(start: number, deleteCount: number, ...items: CsmOperationDescription[]): CsmOperationDescription[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CsmOperationDescription[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CsmOperationDescription[]

      Elements to insert into the array in place of the deleted elements.

    Returns CsmOperationDescription[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: CsmOperationDescription[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CsmOperationDescription[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<CsmOperationDescription>
  • Returns an iterable of values in the array

    Returns IterableIterator<CsmOperationDescription>

type

type: object

className

className: string = "CsmOperationCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CsmOperationDescription"

name

name: "Composite" = "Composite"

Const CsmOperationDescription

CsmOperationDescription: object

Description of an operation available for Microsoft.Web resource provider.

Optional display

Optional name

name: undefined | string

Optional origin

origin: undefined | string

Optional properties

serializedName

serializedName: string = "CsmOperationDescription"

type

type: object

className

className: string = "CsmOperationDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "CsmOperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

name: "String" = "String"

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "CsmOperationDescriptionProperties"

name

name: "Composite" = "Composite"

Const CsmOperationDescriptionProperties

CsmOperationDescriptionProperties: object

Properties available for a Microsoft.Web resource provider operation.

serializedName

serializedName: string = "CsmOperationDescriptionProperties"

Optional serviceSpecification

serviceSpecification: ServiceSpecification

type

type: object

className

className: string = "CsmOperationDescriptionProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

serviceSpecification

serviceSpecification: object

serializedName

serializedName: string = "serviceSpecification"

type

type: object

className

className: string = "ServiceSpecification"

name

name: "Composite" = "Composite"

Const CsmOperationDisplay

CsmOperationDisplay: object

Meta data about operation used for display in portal.

Optional description

description: undefined | string

Optional operation

operation: undefined | string

Optional provider

provider: undefined | string

Optional resource

resource: undefined | string

serializedName

serializedName: string = "CsmOperationDisplay"

type

type: object

className

className: string = "CsmOperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const CsmPublishingProfileOptions

CsmPublishingProfileOptions: object

Publishing options for requested profile.

Optional format

Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp. Possible values include: 'FileZilla3', 'WebDeploy', 'Ftp'

Optional includeDisasterRecoveryEndpoints

includeDisasterRecoveryEndpoints: undefined | false | true

Include the DisasterRecover endpoint if true

serializedName

serializedName: string = "CsmPublishingProfileOptions"

type

type: object

className

className: string = "CsmPublishingProfileOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

format

format: object

serializedName

serializedName: string = "format"

type

type: object

name

name: "String" = "String"

includeDisasterRecoveryEndpoints

includeDisasterRecoveryEndpoints: object

serializedName

serializedName: string = "includeDisasterRecoveryEndpoints"

type

type: object

name

name: "Boolean" = "Boolean"

Const CsmSlotEntity

CsmSlotEntity: object

Deployment slot parameters.

preserveVnet

preserveVnet: boolean

true to preserve Virtual Network to the slot during swap; otherwise, false.

serializedName

serializedName: string = "CsmSlotEntity"

targetSlot

targetSlot: string

Destination deployment slot during swap operation.

type

type: object

className

className: string = "CsmSlotEntity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

preserveVnet

preserveVnet: object

required

required: true = true

serializedName

serializedName: string = "preserveVnet"

type

type: object

name

name: "Boolean" = "Boolean"

targetSlot

targetSlot: object

required

required: true = true

serializedName

serializedName: string = "targetSlot"

type

type: object

name

name: "String" = "String"

Const CsmUsageQuota

CsmUsageQuota: object

Usage of the quota resource.

Optional currentValue

currentValue: undefined | number

The current value of the resource counter.

Optional limit

limit: undefined | number

The resource limit.

Optional name

Quota name.

Optional nextResetTime

nextResetTime: Date

Next reset time for the resource counter.

serializedName

serializedName: string = "CsmUsageQuota"

Optional unit

unit: undefined | string

Units of measurement for the quota resource.

type

type: object

className

className: string = "CsmUsageQuota"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

currentValue

currentValue: object

serializedName

serializedName: string = "currentValue"

type

type: object

name

name: "Number" = "Number"

limit

limit: object

serializedName

serializedName: string = "limit"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

nextResetTime

nextResetTime: object

serializedName

serializedName: string = "nextResetTime"

type

type: object

name

name: "DateTime" = "DateTime"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const CsmUsageQuotaCollection

CsmUsageQuotaCollection: object
interface

Collection of CSM usage quotas.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CsmUsageQuotaCollection"

__@iterator

  • __@iterator(): IterableIterator<CsmUsageQuota>
  • Iterator

    Returns IterableIterator<CsmUsageQuota>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<CsmUsageQuota>[]): CsmUsageQuota[]
  • concat(...items: (T | ConcatArray<T>)[]): CsmUsageQuota[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<CsmUsageQuota>[]

      Additional items to add to the end of array1.

    Returns CsmUsageQuota[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns CsmUsageQuota[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, CsmUsageQuota]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, CsmUsageQuota]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): boolean
        • Parameters

          • value: CsmUsageQuota
          • index: number
          • array: CsmUsageQuota[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: CsmUsageQuota, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: CsmUsageQuota

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): CsmUsageQuota[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: CsmUsageQuota

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): boolean
        • Parameters

          • value: CsmUsageQuota
          • index: number
          • array: CsmUsageQuota[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): any
        • Parameters

          • value: CsmUsageQuota
          • index: number
          • array: CsmUsageQuota[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns CsmUsageQuota[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): CsmUsageQuota | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: CsmUsageQuota

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: CsmUsageQuota, index: number, obj: CsmUsageQuota[]): boolean
        • Parameters

          • this: void
          • value: CsmUsageQuota
          • index: number
          • obj: CsmUsageQuota[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: CsmUsageQuota, index: number, obj: CsmUsageQuota[]): boolean
        • Parameters

          • value: CsmUsageQuota
          • index: number
          • obj: CsmUsageQuota[]

          Returns boolean

    • Optional thisArg: any

    Returns CsmUsageQuota | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: CsmUsageQuota, index: number, obj: CsmUsageQuota[]): boolean
        • Parameters

          • value: CsmUsageQuota
          • index: number
          • obj: CsmUsageQuota[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): void
        • Parameters

          • value: CsmUsageQuota
          • index: number
          • array: CsmUsageQuota[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: CsmUsageQuota, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: CsmUsageQuota

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: CsmUsageQuota, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: CsmUsageQuota

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: CsmUsageQuota, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: CsmUsageQuota

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): U
        • Parameters

          • value: CsmUsageQuota
          • index: number
          • array: CsmUsageQuota[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): CsmUsageQuota | undefined
  • Removes the last element from an array and returns it.

    Returns CsmUsageQuota | undefined

push

  • push(...items: CsmUsageQuota[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: CsmUsageQuota[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): CsmUsageQuota
  • reduce(callbackfn: function, initialValue: CsmUsageQuota): CsmUsageQuota
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: CsmUsageQuota, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): CsmUsageQuota
        • Parameters

          • previousValue: CsmUsageQuota
          • currentValue: CsmUsageQuota
          • currentIndex: number
          • array: CsmUsageQuota[]

          Returns CsmUsageQuota

    Returns CsmUsageQuota

  • Parameters

    • callbackfn: function
        • (previousValue: CsmUsageQuota, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): CsmUsageQuota
        • Parameters

          • previousValue: CsmUsageQuota
          • currentValue: CsmUsageQuota
          • currentIndex: number
          • array: CsmUsageQuota[]

          Returns CsmUsageQuota

    • initialValue: CsmUsageQuota

    Returns CsmUsageQuota

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): U
        • Parameters

          • previousValue: U
          • currentValue: CsmUsageQuota
          • currentIndex: number
          • array: CsmUsageQuota[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): CsmUsageQuota
  • reduceRight(callbackfn: function, initialValue: CsmUsageQuota): CsmUsageQuota
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: CsmUsageQuota, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): CsmUsageQuota
        • Parameters

          • previousValue: CsmUsageQuota
          • currentValue: CsmUsageQuota
          • currentIndex: number
          • array: CsmUsageQuota[]

          Returns CsmUsageQuota

    Returns CsmUsageQuota

  • Parameters

    • callbackfn: function
        • (previousValue: CsmUsageQuota, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): CsmUsageQuota
        • Parameters

          • previousValue: CsmUsageQuota
          • currentValue: CsmUsageQuota
          • currentIndex: number
          • array: CsmUsageQuota[]

          Returns CsmUsageQuota

    • initialValue: CsmUsageQuota

    Returns CsmUsageQuota

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): U
        • Parameters

          • previousValue: U
          • currentValue: CsmUsageQuota
          • currentIndex: number
          • array: CsmUsageQuota[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): CsmUsageQuota[]
  • Reverses the elements in an Array.

    Returns CsmUsageQuota[]

shift

  • shift(): CsmUsageQuota | undefined
  • Removes the first element from an array and returns it.

    Returns CsmUsageQuota | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): CsmUsageQuota[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns CsmUsageQuota[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): boolean
        • Parameters

          • value: CsmUsageQuota
          • index: number
          • array: CsmUsageQuota[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): CsmUsageQuota[]
  • splice(start: number, deleteCount: number, ...items: CsmUsageQuota[]): CsmUsageQuota[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns CsmUsageQuota[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: CsmUsageQuota[]

      Elements to insert into the array in place of the deleted elements.

    Returns CsmUsageQuota[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: CsmUsageQuota[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: CsmUsageQuota[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<CsmUsageQuota>
  • Returns an iterable of values in the array

    Returns IterableIterator<CsmUsageQuota>

type

type: object

className

className: string = "CsmUsageQuotaCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "CsmUsageQuota"

name

name: "Composite" = "Composite"

Const CustomHostnameAnalysisResult

CustomHostnameAnalysisResult: object

Custom domain analysis.

Optional aRecords

aRecords: string[]

A records controller can see for this hostname.

Optional alternateCNameRecords

alternateCNameRecords: string[]

Alternate CName records controller can see for this hostname.

Optional alternateTxtRecords

alternateTxtRecords: string[]

Alternate TXT records controller can see for this hostname.

Optional cNameRecords

cNameRecords: string[]

CName records controller can see for this hostname.

Optional conflictingAppResourceId

conflictingAppResourceId: undefined | string

Name of the conflicting app on scale unit if it's within the same subscription. NOTE: This property will not be serialized. It can only be populated by the server.

Optional customDomainVerificationFailureInfo

customDomainVerificationFailureInfo: ErrorEntity

Raw failure information if DNS verification fails. NOTE: This property will not be serialized. It can only be populated by the server.

Optional customDomainVerificationTest

customDomainVerificationTest: DnsVerificationTestResult

DNS verification test result. Possible values include: 'Passed', 'Failed', 'Skipped' NOTE: This property will not be serialized. It can only be populated by the server.

Optional hasConflictAcrossSubscription

hasConflictAcrossSubscription: undefined | false | true

true if there is a conflict across subscriptions; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hasConflictOnScaleUnit

hasConflictOnScaleUnit: undefined | false | true

true if there is a conflict on a scale unit; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isHostnameAlreadyVerified

isHostnameAlreadyVerified: undefined | false | true

true if hostname is already verified; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CustomHostnameAnalysisResult"

Optional txtRecords

txtRecords: string[]

TXT records controller can see for this hostname.

type

type: object

className

className: string = "CustomHostnameAnalysisResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aRecords

aRecords: object

serializedName

serializedName: string = "properties.aRecords"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

alternateCNameRecords

alternateCNameRecords: object

serializedName

serializedName: string = "properties.alternateCNameRecords"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

alternateTxtRecords

alternateTxtRecords: object

serializedName

serializedName: string = "properties.alternateTxtRecords"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

cNameRecords

cNameRecords: object

serializedName

serializedName: string = "properties.cNameRecords"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

conflictingAppResourceId

conflictingAppResourceId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.conflictingAppResourceId"

type

type: object

name

name: "String" = "String"

customDomainVerificationFailureInfo

customDomainVerificationFailureInfo: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.customDomainVerificationFailureInfo"

type

type: object

className

className: string = "ErrorEntity"

name

name: "Composite" = "Composite"

customDomainVerificationTest

customDomainVerificationTest: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.customDomainVerificationTest"

type

type: object

allowedValues

allowedValues: string[] = ["Passed","Failed","Skipped"]

name

name: "Enum" = "Enum"

hasConflictAcrossSubscription

hasConflictAcrossSubscription: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hasConflictAcrossSubscription"

type

type: object

name

name: "Boolean" = "Boolean"

hasConflictOnScaleUnit

hasConflictOnScaleUnit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hasConflictOnScaleUnit"

type

type: object

name

name: "Boolean" = "Boolean"

isHostnameAlreadyVerified

isHostnameAlreadyVerified: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isHostnameAlreadyVerified"

type

type: object

name

name: "Boolean" = "Boolean"

txtRecords

txtRecords: object

serializedName

serializedName: string = "properties.txtRecords"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const DatabaseBackupSetting

DatabaseBackupSetting: object

Database backup settings.

Optional connectionString

connectionString: undefined | string

Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.

Optional connectionStringName

connectionStringName: undefined | string

Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.

databaseType

databaseType: DatabaseType

Database type (e.g. SqlAzure / MySql). Possible values include: 'SqlAzure', 'MySql', 'LocalMySql', 'PostgreSql'

Optional name

name: undefined | string

serializedName

serializedName: string = "DatabaseBackupSetting"

type

type: object

className

className: string = "DatabaseBackupSetting"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "connectionString"

type

type: object

name

name: "String" = "String"

connectionStringName

connectionStringName: object

serializedName

serializedName: string = "connectionStringName"

type

type: object

name

name: "String" = "String"

databaseType

databaseType: object

required

required: true = true

serializedName

serializedName: string = "databaseType"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const DefaultErrorResponse

DefaultErrorResponse: object

App Service error response.

Optional error

Error model. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DefaultErrorResponse"

type

type: object

className

className: string = "DefaultErrorResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "DefaultErrorResponseError"

name

name: "Composite" = "Composite"

Const DefaultErrorResponseError

DefaultErrorResponseError: object

Error model.

Optional code

code: undefined | string

Standardized string to programmatically identify the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional details

details: DefaultErrorResponseErrorDetailsItem[]

Optional innererror

innererror: undefined | string

More information to debug error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string

Detailed error description and debugging information. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DefaultErrorResponse_error"

Optional target

target: undefined | string

Detailed error description and debugging information. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "DefaultErrorResponseError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DefaultErrorResponseErrorDetailsItem"

name

name: "Composite" = "Composite"

innererror

innererror: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "innererror"

type

type: object

name

name: "String" = "String"

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const DefaultErrorResponseErrorDetailsItem

DefaultErrorResponseErrorDetailsItem: object

Detailed errors.

Optional code

code: undefined | string

Standardized string to programmatically identify the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string

Detailed error description and debugging information. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DefaultErrorResponse_error_detailsItem"

Optional target

target: undefined | string

Detailed error description and debugging information. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "DefaultErrorResponseErrorDetailsItem"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

target

target: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "target"

type

type: object

name

name: "String" = "String"

Const DeletedAppRestoreRequest

DeletedAppRestoreRequest: object

Details about restoring a deleted app.

Optional deletedSiteId

deletedSiteId: undefined | string

ARM resource ID of the deleted app. Example: /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recoverConfiguration

recoverConfiguration: undefined | false | true

If true, deleted site configuration, in addition to content, will be restored.

serializedName

serializedName: string = "DeletedAppRestoreRequest"

Optional snapshotTime

snapshotTime: undefined | string

Point in time to restore the deleted app from, formatted as a DateTime string. If unspecified, default value is the time that the app was deleted.

Optional useDRSecondary

useDRSecondary: undefined | false | true

If true, the snapshot is retrieved from DRSecondary endpoint.

type

type: object

className

className: string = "DeletedAppRestoreRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deletedSiteId

deletedSiteId: object

serializedName

serializedName: string = "properties.deletedSiteId"

type

type: object

name

name: "String" = "String"

recoverConfiguration

recoverConfiguration: object

serializedName

serializedName: string = "properties.recoverConfiguration"

type

type: object

name

name: "Boolean" = "Boolean"

snapshotTime

snapshotTime: object

serializedName

serializedName: string = "properties.snapshotTime"

type

type: object

name

name: "String" = "String"

useDRSecondary

useDRSecondary: object

serializedName

serializedName: string = "properties.useDRSecondary"

type

type: object

name

name: "Boolean" = "Boolean"

Const DeletedSite

DeletedSite: object

A deleted app.

Optional deletedSiteId

deletedSiteId: undefined | number

Numeric id for the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

Optional deletedSiteKind

deletedSiteKind: undefined | string

Kind of site that was deleted NOTE: This property will not be serialized. It can only be populated by the server.

Optional deletedSiteName

deletedSiteName: undefined | string

Name of the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

Optional deletedTimestamp

deletedTimestamp: undefined | string

Time in UTC when the app was deleted. NOTE: This property will not be serialized. It can only be populated by the server.

Optional geoRegionName

geoRegionName: undefined | string

Geo Region of the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGroup

resourceGroup: undefined | string

ResourceGroup that contained the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DeletedSite"

Optional slot

slot: undefined | string

Slot of the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscription

subscription: undefined | string

Subscription containing the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "DeletedSite"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

deletedSiteId

deletedSiteId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.deletedSiteId"

type

type: object

name

name: "Number" = "Number"

deletedSiteKind

deletedSiteKind: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.kind"

type

type: object

name

name: "String" = "String"

deletedSiteName

deletedSiteName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.deletedSiteName"

type

type: object

name

name: "String" = "String"

deletedTimestamp

deletedTimestamp: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.deletedTimestamp"

type

type: object

name

name: "String" = "String"

geoRegionName

geoRegionName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.geoRegionName"

type

type: object

name

name: "String" = "String"

resourceGroup

resourceGroup: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGroup"

type

type: object

name

name: "String" = "String"

slot

slot: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.slot"

type

type: object

name

name: "String" = "String"

subscription

subscription: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.subscription"

type

type: object

name

name: "String" = "String"

Const Deployment

Deployment: object

User credentials used for publishing activity.

Optional active

active: undefined | false | true

True if deployment is currently active, false if completed and null if not started.

Optional author

author: undefined | string

Who authored the deployment.

Optional authorEmail

authorEmail: undefined | string

Author email.

Optional deployer

deployer: undefined | string

Who performed the deployment.

Optional details

details: undefined | string

Details on deployment.

Optional endTime

endTime: Date

End time.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional message

message: undefined | string

Details about deployment status.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Deployment"

Optional startTime

startTime: Date

Start time.

Optional status

status: undefined | number

Deployment status.

type

type: object

className

className: string = "Deployment"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

active

active: object

serializedName

serializedName: string = "properties.active"

type

type: object

name

name: "Boolean" = "Boolean"

author

author: object

serializedName

serializedName: string = "properties.author"

type

type: object

name

name: "String" = "String"

authorEmail

authorEmail: object

serializedName

serializedName: string = "properties.author_email"

type

type: object

name

name: "String" = "String"

deployer

deployer: object

serializedName

serializedName: string = "properties.deployer"

type

type: object

name

name: "String" = "String"

details

details: object

serializedName

serializedName: string = "properties.details"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "properties.end_time"

type

type: object

name

name: "DateTime" = "DateTime"

message

message: object

serializedName

serializedName: string = "properties.message"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "properties.start_time"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "Number" = "Number"

Const DeploymentCollection

DeploymentCollection: object
interface

Collection of app deployments.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DeploymentCollection"

__@iterator

  • __@iterator(): IterableIterator<Deployment>
  • Iterator

    Returns IterableIterator<Deployment>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Deployment>[]): Deployment[]
  • concat(...items: (T | ConcatArray<T>)[]): Deployment[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Deployment>[]

      Additional items to add to the end of array1.

    Returns Deployment[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Deployment[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Deployment]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Deployment]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Deployment, index: number, array: Deployment[]): boolean
        • Parameters

          • value: Deployment
          • index: number
          • array: Deployment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Deployment, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Deployment

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Deployment[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Deployment

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Deployment, index: number, array: Deployment[]): boolean
        • Parameters

          • value: Deployment
          • index: number
          • array: Deployment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Deployment, index: number, array: Deployment[]): any
        • Parameters

          • value: Deployment
          • index: number
          • array: Deployment[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Deployment[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Deployment | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Deployment

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Deployment, index: number, obj: Deployment[]): boolean
        • Parameters

          • this: void
          • value: Deployment
          • index: number
          • obj: Deployment[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Deployment, index: number, obj: Deployment[]): boolean
        • Parameters

          • value: Deployment
          • index: number
          • obj: Deployment[]

          Returns boolean

    • Optional thisArg: any

    Returns Deployment | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Deployment, index: number, obj: Deployment[]): boolean
        • Parameters

          • value: Deployment
          • index: number
          • obj: Deployment[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Deployment, index: number, array: Deployment[]): void
        • Parameters

          • value: Deployment
          • index: number
          • array: Deployment[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Deployment, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Deployment

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Deployment, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Deployment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Deployment, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Deployment

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Deployment, index: number, array: Deployment[]): U
        • Parameters

          • value: Deployment
          • index: number
          • array: Deployment[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Deployment | undefined
  • Removes the last element from an array and returns it.

    Returns Deployment | undefined

push

  • push(...items: Deployment[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Deployment[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Deployment
  • reduce(callbackfn: function, initialValue: Deployment): Deployment
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Deployment, currentValue: Deployment, currentIndex: number, array: Deployment[]): Deployment
        • Parameters

          • previousValue: Deployment
          • currentValue: Deployment
          • currentIndex: number
          • array: Deployment[]

          Returns Deployment

    Returns Deployment

  • Parameters

    • callbackfn: function
        • (previousValue: Deployment, currentValue: Deployment, currentIndex: number, array: Deployment[]): Deployment
        • Parameters

          • previousValue: Deployment
          • currentValue: Deployment
          • currentIndex: number
          • array: Deployment[]

          Returns Deployment

    • initialValue: Deployment

    Returns Deployment

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Deployment, currentIndex: number, array: Deployment[]): U
        • Parameters

          • previousValue: U
          • currentValue: Deployment
          • currentIndex: number
          • array: Deployment[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Deployment
  • reduceRight(callbackfn: function, initialValue: Deployment): Deployment
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Deployment, currentValue: Deployment, currentIndex: number, array: Deployment[]): Deployment
        • Parameters

          • previousValue: Deployment
          • currentValue: Deployment
          • currentIndex: number
          • array: Deployment[]

          Returns Deployment

    Returns Deployment

  • Parameters

    • callbackfn: function
        • (previousValue: Deployment, currentValue: Deployment, currentIndex: number, array: Deployment[]): Deployment
        • Parameters

          • previousValue: Deployment
          • currentValue: Deployment
          • currentIndex: number
          • array: Deployment[]

          Returns Deployment

    • initialValue: Deployment

    Returns Deployment

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Deployment, currentIndex: number, array: Deployment[]): U
        • Parameters

          • previousValue: U
          • currentValue: Deployment
          • currentIndex: number
          • array: Deployment[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Deployment[]
  • Reverses the elements in an Array.

    Returns Deployment[]

shift

  • shift(): Deployment | undefined
  • Removes the first element from an array and returns it.

    Returns Deployment | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Deployment[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Deployment[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Deployment, index: number, array: Deployment[]): boolean
        • Parameters

          • value: Deployment
          • index: number
          • array: Deployment[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Deployment[]
  • splice(start: number, deleteCount: number, ...items: Deployment[]): Deployment[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Deployment[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Deployment[]

      Elements to insert into the array in place of the deleted elements.

    Returns Deployment[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Deployment[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Deployment[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Deployment>
  • Returns an iterable of values in the array

    Returns IterableIterator<Deployment>

type

type: object

className

className: string = "DeploymentCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Deployment"

name

name: "Composite" = "Composite"

Const DeploymentLocations

DeploymentLocations: object

List of available locations (regions or App Service Environments) for deployment of App Service resources.

Optional hostingEnvironmentDeploymentInfos

hostingEnvironmentDeploymentInfos: HostingEnvironmentDeploymentInfo[]

Available App Service Environments with basic information.

Optional hostingEnvironments

hostingEnvironments: AppServiceEnvironment[]

Available App Service Environments with full descriptions of the environments.

Optional locations

locations: GeoRegion[]

Available regions.

serializedName

serializedName: string = "DeploymentLocations"

type

type: object

className

className: string = "DeploymentLocations"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hostingEnvironmentDeploymentInfos

hostingEnvironmentDeploymentInfos: object

serializedName

serializedName: string = "hostingEnvironmentDeploymentInfos"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HostingEnvironmentDeploymentInfo"

name

name: "Composite" = "Composite"

hostingEnvironments

hostingEnvironments: object

serializedName

serializedName: string = "hostingEnvironments"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AppServiceEnvironment"

name

name: "Composite" = "Composite"

locations

locations: object

serializedName

serializedName: string = "locations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GeoRegion"

name

name: "Composite" = "Composite"

Const Dimension

Dimension: object

Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app, where instance name is dimension of the metric HTTP request

Optional displayName

displayName: undefined | string

Optional internalName

internalName: undefined | string

Optional name

name: undefined | string

serializedName

serializedName: string = "Dimension"

Optional toBeExportedForShoebox

toBeExportedForShoebox: undefined | false | true

type

type: object

className

className: string = "Dimension"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

internalName

internalName: object

serializedName

serializedName: string = "internalName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

toBeExportedForShoebox

toBeExportedForShoebox: object

serializedName

serializedName: string = "toBeExportedForShoebox"

type

type: object

name

name: "Boolean" = "Boolean"

Const EnabledConfig

EnabledConfig: object

Enabled configuration.

Optional enabled

enabled: undefined | false | true

True if configuration is enabled, false if it is disabled and null if configuration is not set.

serializedName

serializedName: string = "EnabledConfig"

type

type: object

className

className: string = "EnabledConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const ErrorEntity

ErrorEntity: object

Body of the error response returned from the API.

Optional code

code: undefined | string

Basic error code.

Optional extendedCode

extendedCode: undefined | string

Type of error.

Optional innerErrors

innerErrors: ErrorEntity[]

Inner errors.

Optional message

message: undefined | string

Any details of the error.

Optional messageTemplate

messageTemplate: undefined | string

Message template.

Optional parameters

parameters: string[]

Parameters for the template.

serializedName

serializedName: string = "ErrorEntity"

type

type: object

className

className: string = "ErrorEntity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

extendedCode

extendedCode: object

serializedName

serializedName: string = "extendedCode"

type

type: object

name

name: "String" = "String"

innerErrors

innerErrors: object

serializedName

serializedName: string = "innerErrors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorEntity"

name

name: "Composite" = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

messageTemplate

messageTemplate: object

serializedName

serializedName: string = "messageTemplate"

type

type: object

name

name: "String" = "String"

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const Experiments

Experiments: object

Routing rules in production experiments.

Optional rampUpRules

rampUpRules: RampUpRule[]

List of ramp-up rules.

serializedName

serializedName: string = "Experiments"

type

type: object

className

className: string = "Experiments"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

rampUpRules

rampUpRules: object

serializedName

serializedName: string = "rampUpRules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RampUpRule"

name

name: "Composite" = "Composite"

Const FileSystemApplicationLogsConfig

FileSystemApplicationLogsConfig: object

Application logs to file system configuration.

Optional level

level: LogLevel

Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'. Default value: 'Off'.

serializedName

serializedName: string = "FileSystemApplicationLogsConfig"

type

type: object

className

className: string = "FileSystemApplicationLogsConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

level

level: object

defaultValue

defaultValue: string = "Off"

serializedName

serializedName: string = "level"

type

type: object

allowedValues

allowedValues: string[] = ["Off","Verbose","Information","Warning","Error"]

name

name: "Enum" = "Enum"

Const FileSystemHttpLogsConfig

FileSystemHttpLogsConfig: object

Http logs to file system configuration.

Optional enabled

enabled: undefined | false | true

True if configuration is enabled, false if it is disabled and null if configuration is not set.

Optional retentionInDays

retentionInDays: undefined | number

Retention in days. Remove files older than X days. 0 or lower means no retention.

Optional retentionInMb

retentionInMb: undefined | number

Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100.

serializedName

serializedName: string = "FileSystemHttpLogsConfig"

type

type: object

className

className: string = "FileSystemHttpLogsConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

retentionInDays

retentionInDays: object

serializedName

serializedName: string = "retentionInDays"

type

type: object

name

name: "Number" = "Number"

retentionInMb

retentionInMb: object

serializedName

serializedName: string = "retentionInMb"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 25

type

type: object

name

name: "Number" = "Number"

Const FunctionEnvelope

FunctionEnvelope: object

Web Job Information.

Optional config

config: any

Config information.

Optional configHref

configHref: undefined | string

Config URI.

Optional files

files: undefined | object

File list.

Optional functionAppId

functionAppId: undefined | string

Function App ID.

Optional href

href: undefined | string

Function URI.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scriptHref

scriptHref: undefined | string

Script URI.

Optional scriptRootPathHref

scriptRootPathHref: undefined | string

Script root path URI.

Optional secretsFileHref

secretsFileHref: undefined | string

Secrets file URI.

serializedName

serializedName: string = "FunctionEnvelope"

Optional testData

testData: undefined | string

Test data used when testing via the Azure Portal.

type

type: object

className

className: string = "FunctionEnvelope"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

config

config: object

serializedName

serializedName: string = "properties.config"

type

type: object

name

name: "Object" = "Object"

configHref

configHref: object

serializedName

serializedName: string = "properties.config_href"

type

type: object

name

name: "String" = "String"

files

files: object

serializedName

serializedName: string = "properties.files"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

functionAppId

functionAppId: object

serializedName

serializedName: string = "properties.function_app_id"

type

type: object

name

name: "String" = "String"

href

href: object

serializedName

serializedName: string = "properties.href"

type

type: object

name

name: "String" = "String"

scriptHref

scriptHref: object

serializedName

serializedName: string = "properties.script_href"

type

type: object

name

name: "String" = "String"

scriptRootPathHref

scriptRootPathHref: object

serializedName

serializedName: string = "properties.script_root_path_href"

type

type: object

name

name: "String" = "String"

secretsFileHref

secretsFileHref: object

serializedName

serializedName: string = "properties.secrets_file_href"

type

type: object

name

name: "String" = "String"

testData

testData: object

serializedName

serializedName: string = "properties.test_data"

type

type: object

name

name: "String" = "String"

Const FunctionEnvelopeCollection

FunctionEnvelopeCollection: object
interface

Collection of Kudu function information elements.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "FunctionEnvelopeCollection"

__@iterator

  • __@iterator(): IterableIterator<FunctionEnvelope>
  • Iterator

    Returns IterableIterator<FunctionEnvelope>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<FunctionEnvelope>[]): FunctionEnvelope[]
  • concat(...items: (T | ConcatArray<T>)[]): FunctionEnvelope[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<FunctionEnvelope>[]

      Additional items to add to the end of array1.

    Returns FunctionEnvelope[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns FunctionEnvelope[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, FunctionEnvelope]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, FunctionEnvelope]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): boolean
        • Parameters

          • value: FunctionEnvelope
          • index: number
          • array: FunctionEnvelope[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: FunctionEnvelope, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: FunctionEnvelope

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): FunctionEnvelope[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: FunctionEnvelope

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): boolean
        • Parameters

          • value: FunctionEnvelope
          • index: number
          • array: FunctionEnvelope[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): any
        • Parameters

          • value: FunctionEnvelope
          • index: number
          • array: FunctionEnvelope[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns FunctionEnvelope[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): FunctionEnvelope | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: FunctionEnvelope

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: FunctionEnvelope, index: number, obj: FunctionEnvelope[]): boolean
        • Parameters

          • this: void
          • value: FunctionEnvelope
          • index: number
          • obj: FunctionEnvelope[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: FunctionEnvelope, index: number, obj: FunctionEnvelope[]): boolean
        • Parameters

          • value: FunctionEnvelope
          • index: number
          • obj: FunctionEnvelope[]

          Returns boolean

    • Optional thisArg: any

    Returns FunctionEnvelope | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: FunctionEnvelope, index: number, obj: FunctionEnvelope[]): boolean
        • Parameters

          • value: FunctionEnvelope
          • index: number
          • obj: FunctionEnvelope[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): void
        • Parameters

          • value: FunctionEnvelope
          • index: number
          • array: FunctionEnvelope[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: FunctionEnvelope, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: FunctionEnvelope

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: FunctionEnvelope, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: FunctionEnvelope

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: FunctionEnvelope, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: FunctionEnvelope

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): U
        • Parameters

          • value: FunctionEnvelope
          • index: number
          • array: FunctionEnvelope[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): FunctionEnvelope | undefined
  • Removes the last element from an array and returns it.

    Returns FunctionEnvelope | undefined

push

  • push(...items: FunctionEnvelope[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: FunctionEnvelope[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): FunctionEnvelope
  • reduce(callbackfn: function, initialValue: FunctionEnvelope): FunctionEnvelope
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: FunctionEnvelope, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): FunctionEnvelope
        • Parameters

          • previousValue: FunctionEnvelope
          • currentValue: FunctionEnvelope
          • currentIndex: number
          • array: FunctionEnvelope[]

          Returns FunctionEnvelope

    Returns FunctionEnvelope

  • Parameters

    • callbackfn: function
        • (previousValue: FunctionEnvelope, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): FunctionEnvelope
        • Parameters

          • previousValue: FunctionEnvelope
          • currentValue: FunctionEnvelope
          • currentIndex: number
          • array: FunctionEnvelope[]

          Returns FunctionEnvelope

    • initialValue: FunctionEnvelope

    Returns FunctionEnvelope

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): U
        • Parameters

          • previousValue: U
          • currentValue: FunctionEnvelope
          • currentIndex: number
          • array: FunctionEnvelope[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): FunctionEnvelope
  • reduceRight(callbackfn: function, initialValue: FunctionEnvelope): FunctionEnvelope
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: FunctionEnvelope, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): FunctionEnvelope
        • Parameters

          • previousValue: FunctionEnvelope
          • currentValue: FunctionEnvelope
          • currentIndex: number
          • array: FunctionEnvelope[]

          Returns FunctionEnvelope

    Returns FunctionEnvelope

  • Parameters

    • callbackfn: function
        • (previousValue: FunctionEnvelope, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): FunctionEnvelope
        • Parameters

          • previousValue: FunctionEnvelope
          • currentValue: FunctionEnvelope
          • currentIndex: number
          • array: FunctionEnvelope[]

          Returns FunctionEnvelope

    • initialValue: FunctionEnvelope

    Returns FunctionEnvelope

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): U
        • Parameters

          • previousValue: U
          • currentValue: FunctionEnvelope
          • currentIndex: number
          • array: FunctionEnvelope[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): FunctionEnvelope[]
  • Reverses the elements in an Array.

    Returns FunctionEnvelope[]

shift

  • shift(): FunctionEnvelope | undefined
  • Removes the first element from an array and returns it.

    Returns FunctionEnvelope | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): FunctionEnvelope[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns FunctionEnvelope[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): boolean
        • Parameters

          • value: FunctionEnvelope
          • index: number
          • array: FunctionEnvelope[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): FunctionEnvelope[]
  • splice(start: number, deleteCount: number, ...items: FunctionEnvelope[]): FunctionEnvelope[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns FunctionEnvelope[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: FunctionEnvelope[]

      Elements to insert into the array in place of the deleted elements.

    Returns FunctionEnvelope[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: FunctionEnvelope[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: FunctionEnvelope[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<FunctionEnvelope>
  • Returns an iterable of values in the array

    Returns IterableIterator<FunctionEnvelope>

type

type: object

className

className: string = "FunctionEnvelopeCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "FunctionEnvelope"

name

name: "Composite" = "Composite"

Const FunctionSecrets

FunctionSecrets: object

Function secrets.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional key

key: undefined | string

Secret key.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "FunctionSecrets"

Optional triggerUrl

triggerUrl: undefined | string

Trigger URL.

type

type: object

className

className: string = "FunctionSecrets"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "properties.key"

type

type: object

name

name: "String" = "String"

triggerUrl

triggerUrl: object

serializedName

serializedName: string = "properties.trigger_url"

type

type: object

name

name: "String" = "String"

Const GeoDistribution

GeoDistribution: object

A global distribution definition.

Optional location

location: undefined | string

Location.

Optional numberOfWorkers

numberOfWorkers: undefined | number

NumberOfWorkers.

serializedName

serializedName: string = "GeoDistribution"

type

type: object

className

className: string = "GeoDistribution"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

numberOfWorkers

numberOfWorkers: object

serializedName

serializedName: string = "numberOfWorkers"

type

type: object

name

name: "Number" = "Number"

Const GeoRegion

GeoRegion: object

Geographical region.

Optional description

description: undefined | string

Region description. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

Display name for region. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "GeoRegion"

type

type: object

className

className: string = "GeoRegion"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

Const GeoRegionCollection

GeoRegionCollection: object
interface

Collection of geographical regions.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "GeoRegionCollection"

__@iterator

  • __@iterator(): IterableIterator<GeoRegion>
  • Iterator

    Returns IterableIterator<GeoRegion>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<GeoRegion>[]): GeoRegion[]
  • concat(...items: (T | ConcatArray<T>)[]): GeoRegion[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<GeoRegion>[]

      Additional items to add to the end of array1.

    Returns GeoRegion[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns GeoRegion[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, GeoRegion]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, GeoRegion]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: GeoRegion, index: number, array: GeoRegion[]): boolean
        • Parameters

          • value: GeoRegion
          • index: number
          • array: GeoRegion[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: GeoRegion, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: GeoRegion

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): GeoRegion[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: GeoRegion

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: GeoRegion, index: number, array: GeoRegion[]): boolean
        • Parameters

          • value: GeoRegion
          • index: number
          • array: GeoRegion[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: GeoRegion, index: number, array: GeoRegion[]): any
        • Parameters

          • value: GeoRegion
          • index: number
          • array: GeoRegion[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns GeoRegion[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): GeoRegion | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: GeoRegion

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: GeoRegion, index: number, obj: GeoRegion[]): boolean
        • Parameters

          • this: void
          • value: GeoRegion
          • index: number
          • obj: GeoRegion[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: GeoRegion, index: number, obj: GeoRegion[]): boolean
        • Parameters

          • value: GeoRegion
          • index: number
          • obj: GeoRegion[]

          Returns boolean

    • Optional thisArg: any

    Returns GeoRegion | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: GeoRegion, index: number, obj: GeoRegion[]): boolean
        • Parameters

          • value: GeoRegion
          • index: number
          • obj: GeoRegion[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: GeoRegion, index: number, array: GeoRegion[]): void
        • Parameters

          • value: GeoRegion
          • index: number
          • array: GeoRegion[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: GeoRegion, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: GeoRegion

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: GeoRegion, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: GeoRegion

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: GeoRegion, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: GeoRegion

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: GeoRegion, index: number, array: GeoRegion[]): U
        • Parameters

          • value: GeoRegion
          • index: number
          • array: GeoRegion[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): GeoRegion | undefined
  • Removes the last element from an array and returns it.

    Returns GeoRegion | undefined

push

  • push(...items: GeoRegion[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: GeoRegion[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): GeoRegion
  • reduce(callbackfn: function, initialValue: GeoRegion): GeoRegion
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: GeoRegion, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): GeoRegion
        • Parameters

          • previousValue: GeoRegion
          • currentValue: GeoRegion
          • currentIndex: number
          • array: GeoRegion[]

          Returns GeoRegion

    Returns GeoRegion

  • Parameters

    • callbackfn: function
        • (previousValue: GeoRegion, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): GeoRegion
        • Parameters

          • previousValue: GeoRegion
          • currentValue: GeoRegion
          • currentIndex: number
          • array: GeoRegion[]

          Returns GeoRegion

    • initialValue: GeoRegion

    Returns GeoRegion

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): U
        • Parameters

          • previousValue: U
          • currentValue: GeoRegion
          • currentIndex: number
          • array: GeoRegion[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): GeoRegion
  • reduceRight(callbackfn: function, initialValue: GeoRegion): GeoRegion
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: GeoRegion, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): GeoRegion
        • Parameters

          • previousValue: GeoRegion
          • currentValue: GeoRegion
          • currentIndex: number
          • array: GeoRegion[]

          Returns GeoRegion

    Returns GeoRegion

  • Parameters

    • callbackfn: function
        • (previousValue: GeoRegion, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): GeoRegion
        • Parameters

          • previousValue: GeoRegion
          • currentValue: GeoRegion
          • currentIndex: number
          • array: GeoRegion[]

          Returns GeoRegion

    • initialValue: GeoRegion

    Returns GeoRegion

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): U
        • Parameters

          • previousValue: U
          • currentValue: GeoRegion
          • currentIndex: number
          • array: GeoRegion[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): GeoRegion[]
  • Reverses the elements in an Array.

    Returns GeoRegion[]

shift

  • shift(): GeoRegion | undefined
  • Removes the first element from an array and returns it.

    Returns GeoRegion | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): GeoRegion[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns GeoRegion[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: GeoRegion, index: number, array: GeoRegion[]): boolean
        • Parameters

          • value: GeoRegion
          • index: number
          • array: GeoRegion[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): GeoRegion[]
  • splice(start: number, deleteCount: number, ...items: GeoRegion[]): GeoRegion[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns GeoRegion[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: GeoRegion[]

      Elements to insert into the array in place of the deleted elements.

    Returns GeoRegion[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: GeoRegion[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: GeoRegion[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<GeoRegion>
  • Returns an iterable of values in the array

    Returns IterableIterator<GeoRegion>

type

type: object

className

className: string = "GeoRegionCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GeoRegion"

name

name: "Composite" = "Composite"

Const GlobalCsmSkuDescription

GlobalCsmSkuDescription: object

A Global SKU Description.

Optional capabilities

capabilities: Capability[]

Capabilities of the SKU, e.g., is traffic manager enabled?

Optional capacity

capacity: SkuCapacity

Min, max, and default scale values of the SKU.

Optional family

family: undefined | string

Family code of the resource SKU.

Optional locations

locations: string[]

Locations of the SKU.

Optional name

name: undefined | string

Name of the resource SKU.

serializedName

serializedName: string = "GlobalCsmSkuDescription"

Optional size

size: undefined | string

Size specifier of the resource SKU.

Optional tier

tier: undefined | string

Service Tier of the resource SKU.

type

type: object

className

className: string = "GlobalCsmSkuDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capabilities

capabilities: object

serializedName

serializedName: string = "capabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Capability"

name

name: "Composite" = "Composite"

capacity

capacity: object

serializedName

serializedName: string = "capacity"

type

type: object

className

className: string = "SkuCapacity"

name

name: "Composite" = "Composite"

family

family: object

serializedName

serializedName: string = "family"

type

type: object

name

name: "String" = "String"

locations

locations: object

serializedName

serializedName: string = "locations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

size

size: object

serializedName

serializedName: string = "size"

type

type: object

name

name: "String" = "String"

tier

tier: object

serializedName

serializedName: string = "tier"

type

type: object

name

name: "String" = "String"

Const HandlerMapping

HandlerMapping: object

The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.

Optional argumentsProperty

argumentsProperty: undefined | string

Command-line arguments to be passed to the script processor.

Optional extension

extension: undefined | string

Requests with this extension will be handled using the specified FastCGI application.

Optional scriptProcessor

scriptProcessor: undefined | string

The absolute path to the FastCGI application.

serializedName

serializedName: string = "HandlerMapping"

type

type: object

className

className: string = "HandlerMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

argumentsProperty

argumentsProperty: object

serializedName

serializedName: string = "arguments"

type

type: object

name

name: "String" = "String"

extension

extension: object

serializedName

serializedName: string = "extension"

type

type: object

name

name: "String" = "String"

scriptProcessor

scriptProcessor: object

serializedName

serializedName: string = "scriptProcessor"

type

type: object

name

name: "String" = "String"

Const HostNameBinding

HostNameBinding: object

A hostname binding object.

Optional azureResourceName

azureResourceName: undefined | string

Azure resource name.

Optional azureResourceType

azureResourceType: AzureResourceType

Azure resource type. Possible values include: 'Website', 'TrafficManager'

Optional customHostNameDnsRecordType

customHostNameDnsRecordType: CustomHostNameDnsRecordType

Custom DNS record type. Possible values include: 'CName', 'A'

Optional domainId

domainId: undefined | string

Fully qualified ARM domain resource URI.

Optional hostNameType

hostNameType: HostNameType

Hostname type. Possible values include: 'Verified', 'Managed'

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HostNameBinding"

Optional siteName

siteName: undefined | string

App Service app name.

Optional sslState

sslState: SslState

SSL type. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'

Optional thumbprint

thumbprint: undefined | string

SSL certificate thumbprint

Optional virtualIP

virtualIP: undefined | string

Virtual IP address assigned to the hostname if IP based SSL is enabled. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "HostNameBinding"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureResourceName

azureResourceName: object

serializedName

serializedName: string = "properties.azureResourceName"

type

type: object

name

name: "String" = "String"

azureResourceType

azureResourceType: object

serializedName

serializedName: string = "properties.azureResourceType"

type

type: object

allowedValues

allowedValues: string[] = ["Website","TrafficManager"]

name

name: "Enum" = "Enum"

customHostNameDnsRecordType

customHostNameDnsRecordType: object

serializedName

serializedName: string = "properties.customHostNameDnsRecordType"

type

type: object

allowedValues

allowedValues: string[] = ["CName","A"]

name

name: "Enum" = "Enum"

domainId

domainId: object

serializedName

serializedName: string = "properties.domainId"

type

type: object

name

name: "String" = "String"

hostNameType

hostNameType: object

serializedName

serializedName: string = "properties.hostNameType"

type

type: object

allowedValues

allowedValues: string[] = ["Verified","Managed"]

name

name: "Enum" = "Enum"

siteName

siteName: object

serializedName

serializedName: string = "properties.siteName"

type

type: object

name

name: "String" = "String"

sslState

sslState: object

serializedName

serializedName: string = "properties.sslState"

type

type: object

allowedValues

allowedValues: string[] = ["Disabled","SniEnabled","IpBasedEnabled"]

name

name: "Enum" = "Enum"

thumbprint

thumbprint: object

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

virtualIP

virtualIP: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.virtualIP"

type

type: object

name

name: "String" = "String"

Const HostNameBindingCollection

HostNameBindingCollection: object
interface

Collection of hostname bindings.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HostNameBindingCollection"

__@iterator

  • __@iterator(): IterableIterator<HostNameBinding>
  • Iterator

    Returns IterableIterator<HostNameBinding>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<HostNameBinding>[]): HostNameBinding[]
  • concat(...items: (T | ConcatArray<T>)[]): HostNameBinding[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<HostNameBinding>[]

      Additional items to add to the end of array1.

    Returns HostNameBinding[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns HostNameBinding[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, HostNameBinding]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, HostNameBinding]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: HostNameBinding, index: number, array: HostNameBinding[]): boolean
        • Parameters

          • value: HostNameBinding
          • index: number
          • array: HostNameBinding[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: HostNameBinding, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: HostNameBinding

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): HostNameBinding[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: HostNameBinding

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: HostNameBinding, index: number, array: HostNameBinding[]): boolean
        • Parameters

          • value: HostNameBinding
          • index: number
          • array: HostNameBinding[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: HostNameBinding, index: number, array: HostNameBinding[]): any
        • Parameters

          • value: HostNameBinding
          • index: number
          • array: HostNameBinding[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns HostNameBinding[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): HostNameBinding | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: HostNameBinding

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: HostNameBinding, index: number, obj: HostNameBinding[]): boolean
        • Parameters

          • this: void
          • value: HostNameBinding
          • index: number
          • obj: HostNameBinding[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: HostNameBinding, index: number, obj: HostNameBinding[]): boolean
        • Parameters

          • value: HostNameBinding
          • index: number
          • obj: HostNameBinding[]

          Returns boolean

    • Optional thisArg: any

    Returns HostNameBinding | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: HostNameBinding, index: number, obj: HostNameBinding[]): boolean
        • Parameters

          • value: HostNameBinding
          • index: number
          • obj: HostNameBinding[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: HostNameBinding, index: number, array: HostNameBinding[]): void
        • Parameters

          • value: HostNameBinding
          • index: number
          • array: HostNameBinding[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: HostNameBinding, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: HostNameBinding

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: HostNameBinding, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: HostNameBinding

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: HostNameBinding, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: HostNameBinding

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: HostNameBinding, index: number, array: HostNameBinding[]): U
        • Parameters

          • value: HostNameBinding
          • index: number
          • array: HostNameBinding[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): HostNameBinding | undefined
  • Removes the last element from an array and returns it.

    Returns HostNameBinding | undefined

push

  • push(...items: HostNameBinding[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: HostNameBinding[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): HostNameBinding
  • reduce(callbackfn: function, initialValue: HostNameBinding): HostNameBinding
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: HostNameBinding, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): HostNameBinding
        • Parameters

          • previousValue: HostNameBinding
          • currentValue: HostNameBinding
          • currentIndex: number
          • array: HostNameBinding[]

          Returns HostNameBinding

    Returns HostNameBinding

  • Parameters

    • callbackfn: function
        • (previousValue: HostNameBinding, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): HostNameBinding
        • Parameters

          • previousValue: HostNameBinding
          • currentValue: HostNameBinding
          • currentIndex: number
          • array: HostNameBinding[]

          Returns HostNameBinding

    • initialValue: HostNameBinding

    Returns HostNameBinding

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): U
        • Parameters

          • previousValue: U
          • currentValue: HostNameBinding
          • currentIndex: number
          • array: HostNameBinding[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): HostNameBinding
  • reduceRight(callbackfn: function, initialValue: HostNameBinding): HostNameBinding
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: HostNameBinding, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): HostNameBinding
        • Parameters

          • previousValue: HostNameBinding
          • currentValue: HostNameBinding
          • currentIndex: number
          • array: HostNameBinding[]

          Returns HostNameBinding

    Returns HostNameBinding

  • Parameters

    • callbackfn: function
        • (previousValue: HostNameBinding, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): HostNameBinding
        • Parameters

          • previousValue: HostNameBinding
          • currentValue: HostNameBinding
          • currentIndex: number
          • array: HostNameBinding[]

          Returns HostNameBinding

    • initialValue: HostNameBinding

    Returns HostNameBinding

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): U
        • Parameters

          • previousValue: U
          • currentValue: HostNameBinding
          • currentIndex: number
          • array: HostNameBinding[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): HostNameBinding[]
  • Reverses the elements in an Array.

    Returns HostNameBinding[]

shift

  • shift(): HostNameBinding | undefined
  • Removes the first element from an array and returns it.

    Returns HostNameBinding | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): HostNameBinding[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns HostNameBinding[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: HostNameBinding, index: number, array: HostNameBinding[]): boolean
        • Parameters

          • value: HostNameBinding
          • index: number
          • array: HostNameBinding[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): HostNameBinding[]
  • splice(start: number, deleteCount: number, ...items: HostNameBinding[]): HostNameBinding[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns HostNameBinding[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: HostNameBinding[]

      Elements to insert into the array in place of the deleted elements.

    Returns HostNameBinding[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: HostNameBinding[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: HostNameBinding[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<HostNameBinding>
  • Returns an iterable of values in the array

    Returns IterableIterator<HostNameBinding>

type

type: object

className

className: string = "HostNameBindingCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HostNameBinding"

name

name: "Composite" = "Composite"

Const HostNameSslState

HostNameSslState: object

SSL-enabled hostname.

Optional hostType

hostType: HostType

Indicates whether the hostname is a standard or repository hostname. Possible values include: 'Standard', 'Repository'

Optional name

name: undefined | string

Hostname.

serializedName

serializedName: string = "HostNameSslState"

Optional sslState

sslState: SslState

SSL type. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'

Optional thumbprint

thumbprint: undefined | string

SSL certificate thumbprint.

Optional toUpdate

toUpdate: undefined | false | true

Set to true to update existing hostname.

Optional virtualIP

virtualIP: undefined | string

Virtual IP address assigned to the hostname if IP based SSL is enabled.

type

type: object

className

className: string = "HostNameSslState"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hostType

hostType: object

serializedName

serializedName: string = "hostType"

type

type: object

allowedValues

allowedValues: string[] = ["Standard","Repository"]

name

name: "Enum" = "Enum"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

sslState

sslState: object

serializedName

serializedName: string = "sslState"

type

type: object

allowedValues

allowedValues: string[] = ["Disabled","SniEnabled","IpBasedEnabled"]

name

name: "Enum" = "Enum"

thumbprint

thumbprint: object

serializedName

serializedName: string = "thumbprint"

type

type: object

name

name: "String" = "String"

toUpdate

toUpdate: object

serializedName

serializedName: string = "toUpdate"

type

type: object

name

name: "Boolean" = "Boolean"

virtualIP

virtualIP: object

serializedName

serializedName: string = "virtualIP"

type

type: object

name

name: "String" = "String"

Const HostingEnvironmentDeploymentInfo

HostingEnvironmentDeploymentInfo: object

Information needed to create resources on an App Service Environment.

Optional location

location: undefined | string

Location of the App Service Environment.

Optional name

name: undefined | string

Name of the App Service Environment.

serializedName

serializedName: string = "HostingEnvironmentDeploymentInfo"

type

type: object

className

className: string = "HostingEnvironmentDeploymentInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const HostingEnvironmentProfile

HostingEnvironmentProfile: object

Specification for an App Service Environment to use for this resource.

Optional id

id: undefined | string

Resource ID of the App Service Environment.

Optional name

name: undefined | string

Name of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HostingEnvironmentProfile"

type

type: object

Resource type of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "HostingEnvironmentProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const HttpLogsConfig

HttpLogsConfig: object

Http logs configuration.

Optional azureBlobStorage

Http logs to azure blob storage configuration.

Optional fileSystem

Http logs to file system configuration.

serializedName

serializedName: string = "HttpLogsConfig"

type

type: object

className

className: string = "HttpLogsConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azureBlobStorage

azureBlobStorage: object

serializedName

serializedName: string = "azureBlobStorage"

type

type: object

className

className: string = "AzureBlobStorageHttpLogsConfig"

name

name: "Composite" = "Composite"

fileSystem

fileSystem: object

serializedName

serializedName: string = "fileSystem"

type

type: object

className

className: string = "FileSystemHttpLogsConfig"

name

name: "Composite" = "Composite"

Const HybridConnection

HybridConnection: object

Hybrid Connection contract. This is used to configure a Hybrid Connection.

Optional hostname

hostname: undefined | string

The hostname of the endpoint.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional port

port: undefined | number

The port of the endpoint.

Optional relayArmUri

relayArmUri: undefined | string

The ARM URI to the Service Bus relay.

Optional relayName

relayName: undefined | string

The name of the Service Bus relay.

Optional sendKeyName

sendKeyName: undefined | string

The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.

Optional sendKeyValue

sendKeyValue: undefined | string

The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.

serializedName

serializedName: string = "HybridConnection"

Optional serviceBusNamespace

serviceBusNamespace: undefined | string

The name of the Service Bus namespace.

Optional serviceBusSuffix

serviceBusSuffix: undefined | string

The suffix for the service bus endpoint. By default this is .servicebus.windows.net

type

type: object

className

className: string = "HybridConnection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hostname

hostname: object

serializedName

serializedName: string = "properties.hostname"

type

type: object

name

name: "String" = "String"

port

port: object

serializedName

serializedName: string = "properties.port"

type

type: object

name

name: "Number" = "Number"

relayArmUri

relayArmUri: object

serializedName

serializedName: string = "properties.relayArmUri"

type

type: object

name

name: "String" = "String"

relayName

relayName: object

serializedName

serializedName: string = "properties.relayName"

type

type: object

name

name: "String" = "String"

sendKeyName

sendKeyName: object

serializedName

serializedName: string = "properties.sendKeyName"

type

type: object

name

name: "String" = "String"

sendKeyValue

sendKeyValue: object

serializedName

serializedName: string = "properties.sendKeyValue"

type

type: object

name

name: "String" = "String"

serviceBusNamespace

serviceBusNamespace: object

serializedName

serializedName: string = "properties.serviceBusNamespace"

type

type: object

name

name: "String" = "String"

serviceBusSuffix

serviceBusSuffix: object

serializedName

serializedName: string = "properties.serviceBusSuffix"

type

type: object

name

name: "String" = "String"

Const HybridConnectionCollection

HybridConnectionCollection: object
interface

Collection of hostname bindings.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HybridConnectionCollection"

__@iterator

  • __@iterator(): IterableIterator<HybridConnection>
  • Iterator

    Returns IterableIterator<HybridConnection>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<HybridConnection>[]): HybridConnection[]
  • concat(...items: (T | ConcatArray<T>)[]): HybridConnection[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<HybridConnection>[]

      Additional items to add to the end of array1.

    Returns HybridConnection[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns HybridConnection[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, HybridConnection]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, HybridConnection]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: HybridConnection, index: number, array: HybridConnection[]): boolean
        • Parameters

          • value: HybridConnection
          • index: number
          • array: HybridConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: HybridConnection, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: HybridConnection

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): HybridConnection[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: HybridConnection

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: HybridConnection, index: number, array: HybridConnection[]): boolean
        • Parameters

          • value: HybridConnection
          • index: number
          • array: HybridConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: HybridConnection, index: number, array: HybridConnection[]): any
        • Parameters

          • value: HybridConnection
          • index: number
          • array: HybridConnection[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns HybridConnection[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): HybridConnection | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: HybridConnection

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: HybridConnection, index: number, obj: HybridConnection[]): boolean
        • Parameters

          • this: void
          • value: HybridConnection
          • index: number
          • obj: HybridConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: HybridConnection, index: number, obj: HybridConnection[]): boolean
        • Parameters

          • value: HybridConnection
          • index: number
          • obj: HybridConnection[]

          Returns boolean

    • Optional thisArg: any

    Returns HybridConnection | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: HybridConnection, index: number, obj: HybridConnection[]): boolean
        • Parameters

          • value: HybridConnection
          • index: number
          • obj: HybridConnection[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: HybridConnection, index: number, array: HybridConnection[]): void
        • Parameters

          • value: HybridConnection
          • index: number
          • array: HybridConnection[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: HybridConnection, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: HybridConnection

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: HybridConnection, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: HybridConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: HybridConnection, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: HybridConnection

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: HybridConnection, index: number, array: HybridConnection[]): U
        • Parameters

          • value: HybridConnection
          • index: number
          • array: HybridConnection[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): HybridConnection | undefined
  • Removes the last element from an array and returns it.

    Returns HybridConnection | undefined

push

  • push(...items: HybridConnection[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: HybridConnection[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): HybridConnection
  • reduce(callbackfn: function, initialValue: HybridConnection): HybridConnection
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: HybridConnection, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): HybridConnection
        • Parameters

          • previousValue: HybridConnection
          • currentValue: HybridConnection
          • currentIndex: number
          • array: HybridConnection[]

          Returns HybridConnection

    Returns HybridConnection

  • Parameters

    • callbackfn: function
        • (previousValue: HybridConnection, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): HybridConnection
        • Parameters

          • previousValue: HybridConnection
          • currentValue: HybridConnection
          • currentIndex: number
          • array: HybridConnection[]

          Returns HybridConnection

    • initialValue: HybridConnection

    Returns HybridConnection

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: HybridConnection
          • currentIndex: number
          • array: HybridConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): HybridConnection
  • reduceRight(callbackfn: function, initialValue: HybridConnection): HybridConnection
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: HybridConnection, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): HybridConnection
        • Parameters

          • previousValue: HybridConnection
          • currentValue: HybridConnection
          • currentIndex: number
          • array: HybridConnection[]

          Returns HybridConnection

    Returns HybridConnection

  • Parameters

    • callbackfn: function
        • (previousValue: HybridConnection, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): HybridConnection
        • Parameters

          • previousValue: HybridConnection
          • currentValue: HybridConnection
          • currentIndex: number
          • array: HybridConnection[]

          Returns HybridConnection

    • initialValue: HybridConnection

    Returns HybridConnection

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): U
        • Parameters

          • previousValue: U
          • currentValue: HybridConnection
          • currentIndex: number
          • array: HybridConnection[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): HybridConnection[]
  • Reverses the elements in an Array.

    Returns HybridConnection[]

shift

  • shift(): HybridConnection | undefined
  • Removes the first element from an array and returns it.

    Returns HybridConnection | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): HybridConnection[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns HybridConnection[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: HybridConnection, index: number, array: HybridConnection[]): boolean
        • Parameters

          • value: HybridConnection
          • index: number
          • array: HybridConnection[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): HybridConnection[]
  • splice(start: number, deleteCount: number, ...items: HybridConnection[]): HybridConnection[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns HybridConnection[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: HybridConnection[]

      Elements to insert into the array in place of the deleted elements.

    Returns HybridConnection[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: HybridConnection[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: HybridConnection[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<HybridConnection>
  • Returns an iterable of values in the array

    Returns IterableIterator<HybridConnection>

type

type: object

className

className: string = "HybridConnectionCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HybridConnection"

name

name: "Composite" = "Composite"

Const HybridConnectionKey

HybridConnectionKey: object

Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sendKeyName

sendKeyName: undefined | string

The name of the send key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sendKeyValue

sendKeyValue: undefined | string

The value of the send key. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HybridConnectionKey"

type

type: object

className

className: string = "HybridConnectionKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

sendKeyName

sendKeyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.sendKeyName"

type

type: object

name

name: "String" = "String"

sendKeyValue

sendKeyValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.sendKeyValue"

type

type: object

name

name: "String" = "String"

Const HybridConnectionLimits

HybridConnectionLimits: object

Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.

Optional current

current: undefined | number

The current number of Hybrid Connections. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional maximum

maximum: undefined | number

The maximum number of Hybrid Connections allowed. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HybridConnectionLimits"

type

type: object

className

className: string = "HybridConnectionLimits"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

current

current: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.current"

type

type: object

name

name: "Number" = "Number"

maximum

maximum: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maximum"

type

type: object

name

name: "Number" = "Number"

Const Identifier

Identifier: object

A domain specific resource identifier.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identifierId

identifierId: undefined | string

String representation of the identity.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Identifier"

type

type: object

className

className: string = "Identifier"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

identifierId

identifierId: object

serializedName

serializedName: string = "properties.id"

type

type: object

name

name: "String" = "String"

Const IdentifierCollection

IdentifierCollection: object
interface

Collection of identifiers.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IdentifierCollection"

__@iterator

  • __@iterator(): IterableIterator<Identifier>
  • Iterator

    Returns IterableIterator<Identifier>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Identifier>[]): Identifier[]
  • concat(...items: (T | ConcatArray<T>)[]): Identifier[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Identifier>[]

      Additional items to add to the end of array1.

    Returns Identifier[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Identifier[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Identifier]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Identifier]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Identifier, index: number, array: Identifier[]): boolean
        • Parameters

          • value: Identifier
          • index: number
          • array: Identifier[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Identifier, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Identifier

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Identifier[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Identifier

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Identifier, index: number, array: Identifier[]): boolean
        • Parameters

          • value: Identifier
          • index: number
          • array: Identifier[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Identifier, index: number, array: Identifier[]): any
        • Parameters

          • value: Identifier
          • index: number
          • array: Identifier[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Identifier[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Identifier | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Identifier

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Identifier, index: number, obj: Identifier[]): boolean
        • Parameters

          • this: void
          • value: Identifier
          • index: number
          • obj: Identifier[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Identifier, index: number, obj: Identifier[]): boolean
        • Parameters

          • value: Identifier
          • index: number
          • obj: Identifier[]

          Returns boolean

    • Optional thisArg: any

    Returns Identifier | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Identifier, index: number, obj: Identifier[]): boolean
        • Parameters

          • value: Identifier
          • index: number
          • obj: Identifier[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Identifier, index: number, array: Identifier[]): void
        • Parameters

          • value: Identifier
          • index: number
          • array: Identifier[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Identifier, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Identifier

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Identifier, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Identifier

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Identifier, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Identifier

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Identifier, index: number, array: Identifier[]): U
        • Parameters

          • value: Identifier
          • index: number
          • array: Identifier[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Identifier | undefined
  • Removes the last element from an array and returns it.

    Returns Identifier | undefined

push

  • push(...items: Identifier[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Identifier[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Identifier
  • reduce(callbackfn: function, initialValue: Identifier): Identifier
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Identifier, currentValue: Identifier, currentIndex: number, array: Identifier[]): Identifier
        • Parameters

          • previousValue: Identifier
          • currentValue: Identifier
          • currentIndex: number
          • array: Identifier[]

          Returns Identifier

    Returns Identifier

  • Parameters

    • callbackfn: function
        • (previousValue: Identifier, currentValue: Identifier, currentIndex: number, array: Identifier[]): Identifier
        • Parameters

          • previousValue: Identifier
          • currentValue: Identifier
          • currentIndex: number
          • array: Identifier[]

          Returns Identifier

    • initialValue: Identifier

    Returns Identifier

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Identifier, currentIndex: number, array: Identifier[]): U
        • Parameters

          • previousValue: U
          • currentValue: Identifier
          • currentIndex: number
          • array: Identifier[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Identifier
  • reduceRight(callbackfn: function, initialValue: Identifier): Identifier
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Identifier, currentValue: Identifier, currentIndex: number, array: Identifier[]): Identifier
        • Parameters

          • previousValue: Identifier
          • currentValue: Identifier
          • currentIndex: number
          • array: Identifier[]

          Returns Identifier

    Returns Identifier

  • Parameters

    • callbackfn: function
        • (previousValue: Identifier, currentValue: Identifier, currentIndex: number, array: Identifier[]): Identifier
        • Parameters

          • previousValue: Identifier
          • currentValue: Identifier
          • currentIndex: number
          • array: Identifier[]

          Returns Identifier

    • initialValue: Identifier

    Returns Identifier

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Identifier, currentIndex: number, array: Identifier[]): U
        • Parameters

          • previousValue: U
          • currentValue: Identifier
          • currentIndex: number
          • array: Identifier[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Identifier[]
  • Reverses the elements in an Array.

    Returns Identifier[]

shift

  • shift(): Identifier | undefined
  • Removes the first element from an array and returns it.

    Returns Identifier | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Identifier[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Identifier[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Identifier, index: number, array: Identifier[]): boolean
        • Parameters

          • value: Identifier
          • index: number
          • array: Identifier[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Identifier[]
  • splice(start: number, deleteCount: number, ...items: Identifier[]): Identifier[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Identifier[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Identifier[]

      Elements to insert into the array in place of the deleted elements.

    Returns Identifier[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Identifier[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Identifier[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Identifier>
  • Returns an iterable of values in the array

    Returns IterableIterator<Identifier>

type

type: object

className

className: string = "IdentifierCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Identifier"

name

name: "Composite" = "Composite"

Const IpSecurityRestriction

IpSecurityRestriction: object

IP security restriction on an app.

Optional action

action: undefined | string

Allow or Deny access for this IP range.

Optional description

description: undefined | string

IP restriction rule description.

Optional ipAddress

ipAddress: undefined | string

IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.

Optional name

name: undefined | string

IP restriction rule name.

Optional priority

priority: undefined | number

Priority of IP restriction rule.

serializedName

serializedName: string = "IpSecurityRestriction"

Optional subnetMask

subnetMask: undefined | string

Subnet mask for the range of IP addresses the restriction is valid for.

Optional subnetTrafficTag

subnetTrafficTag: undefined | number

(internal) Subnet traffic tag

Optional tag

Defines what this IP filter will be used for. This is to support IP filtering on proxies. Possible values include: 'Default', 'XffProxy'

Optional vnetSubnetResourceId

vnetSubnetResourceId: undefined | string

Virtual network resource id

Optional vnetTrafficTag

vnetTrafficTag: undefined | number

(internal) Vnet traffic tag

type

type: object

className

className: string = "IpSecurityRestriction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "action"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

ipAddress

ipAddress: object

serializedName

serializedName: string = "ipAddress"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

priority

priority: object

serializedName

serializedName: string = "priority"

type

type: object

name

name: "Number" = "Number"

subnetMask

subnetMask: object

serializedName

serializedName: string = "subnetMask"

type

type: object

name

name: "String" = "String"

subnetTrafficTag

subnetTrafficTag: object

serializedName

serializedName: string = "subnetTrafficTag"

type

type: object

name

name: "Number" = "Number"

tag

tag: object

serializedName

serializedName: string = "tag"

type

type: object

allowedValues

allowedValues: string[] = ["Default","XffProxy"]

name

name: "Enum" = "Enum"

vnetSubnetResourceId

vnetSubnetResourceId: object

serializedName

serializedName: string = "vnetSubnetResourceId"

type

type: object

name

name: "String" = "String"

vnetTrafficTag

vnetTrafficTag: object

serializedName

serializedName: string = "vnetTrafficTag"

type

type: object

name

name: "Number" = "Number"

Const LocalizableString

LocalizableString: object

Localizable string object containing the name and a localized value.

Optional localizedValue

localizedValue: undefined | string

Localized name.

serializedName

serializedName: string = "LocalizableString"

Optional value

value: undefined | string

Non-localized name.

type

type: object

className

className: string = "LocalizableString"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const LogSpecification

LogSpecification: object

Log Definition of a single resource metric.

Optional blobDuration

blobDuration: undefined | string

Optional displayName

displayName: undefined | string

Optional name

name: undefined | string

serializedName

serializedName: string = "LogSpecification"

type

type: object

className

className: string = "LogSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const MSDeploy

MSDeploy: object

MSDeploy ARM PUT information

Optional appOffline

appOffline: undefined | false | true

Sets the AppOffline rule while the MSDeploy operation executes. Setting is false by default.

Optional connectionString

connectionString: undefined | string

SQL Connection String

Optional dbType

dbType: undefined | string

Database Type

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional packageUri

packageUri: undefined | string

Package URI

serializedName

serializedName: string = "MSDeploy"

Optional setParameters

setParameters: undefined | object

MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.

Optional setParametersXmlFileUri

setParametersXmlFileUri: undefined | string

URI of MSDeploy Parameters file. Must not be set if SetParameters is used.

Optional skipAppData

skipAppData: undefined | false | true

Controls whether the MSDeploy operation skips the App_Data directory. If set to true, the existing App_Data directory on the destination will not be deleted, and any App_Data directory in the source will be ignored. Setting is false by default.

type

type: object

className

className: string = "MSDeploy"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appOffline

appOffline: object

serializedName

serializedName: string = "properties.appOffline"

type

type: object

name

name: "Boolean" = "Boolean"

connectionString

connectionString: object

serializedName

serializedName: string = "properties.connectionString"

type

type: object

name

name: "String" = "String"

dbType

dbType: object

serializedName

serializedName: string = "properties.dbType"

type

type: object

name

name: "String" = "String"

packageUri

packageUri: object

serializedName

serializedName: string = "properties.packageUri"

type

type: object

name

name: "String" = "String"

setParameters

setParameters: object

serializedName

serializedName: string = "properties.setParameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

setParametersXmlFileUri

setParametersXmlFileUri: object

serializedName

serializedName: string = "properties.setParametersXmlFileUri"

type

type: object

name

name: "String" = "String"

skipAppData

skipAppData: object

serializedName

serializedName: string = "properties.skipAppData"

type

type: object

name

name: "Boolean" = "Boolean"

Const MSDeployLog

MSDeployLog: object

MSDeploy log

Optional entries

entries: MSDeployLogEntry[]

List of log entry messages NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MSDeployLog"

type

type: object

className

className: string = "MSDeployLog"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

entries

entries: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.entries"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MSDeployLogEntry"

name

name: "Composite" = "Composite"

Const MSDeployLogEntry

MSDeployLogEntry: object

MSDeploy log entry

Optional message

message: undefined | string

Log entry message NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MSDeployLogEntry"

Optional time

time: Date

Timestamp of log entry NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

Log entry type. Possible values include: 'Message', 'Warning', 'Error' NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "MSDeployLogEntry"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

message

message: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

time

time: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "time"

type

type: object

name

name: "DateTime" = "DateTime"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["Message","Warning","Error"]

name

name: "Enum" = "Enum"

Const MSDeployStatus

MSDeployStatus: object

MSDeploy ARM response

Optional complete

complete: undefined | false | true

Whether the deployment operation has completed NOTE: This property will not be serialized. It can only be populated by the server.

Optional deployer

deployer: undefined | string

Username of deployer NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date

End time of deploy operation NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: MSDeployProvisioningState

Provisioning state. Possible values include: 'accepted', 'running', 'succeeded', 'failed', 'canceled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MSDeployStatus"

Optional startTime

startTime: Date

Start time of deploy operation NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "MSDeployStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

complete

complete: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.complete"

type

type: object

name

name: "Boolean" = "Boolean"

deployer

deployer: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.deployer"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["accepted","running","succeeded","failed","canceled"]

name

name: "Enum" = "Enum"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const ManagedServiceIdentity

ManagedServiceIdentity: object

Managed service identity.

Optional principalId

principalId: undefined | string

Principal Id of managed service identity. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedServiceIdentity"

Optional tenantId

tenantId: undefined | string

Tenant of managed service identity. NOTE: This property will not be serialized. It can only be populated by the server.

Optional userAssignedIdentities

userAssignedIdentities: undefined | object

The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

type

type: object

Type of managed service identity. Possible values include: 'SystemAssigned', 'UserAssigned', 'SystemAssigned, UserAssigned', 'None'

className

className: string = "ManagedServiceIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

principalId

principalId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

tenantId

tenantId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "tenantId"

type

type: object

name

name: "String" = "String"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

userAssignedIdentities

userAssignedIdentities: object

serializedName

serializedName: string = "userAssignedIdentities"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "ManagedServiceIdentityUserAssignedIdentitiesValue"

name

name: "Composite" = "Composite"

Const ManagedServiceIdentityUserAssignedIdentitiesValue

ManagedServiceIdentityUserAssignedIdentitiesValue: object

An interface representing ManagedServiceIdentityUserAssignedIdentitiesValue.

Optional clientId

clientId: undefined | string

Client Id of user assigned identity NOTE: This property will not be serialized. It can only be populated by the server.

Optional principalId

principalId: undefined | string

Principal Id of user assigned identity NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedServiceIdentity_userAssignedIdentitiesValue"

type

type: object

className

className: string = "ManagedServiceIdentityUserAssignedIdentitiesValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientId

clientId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "clientId"

type

type: object

name

name: "String" = "String"

principalId

principalId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "principalId"

type

type: object

name

name: "String" = "String"

Const MetricAvailability

MetricAvailability: object

Retention policy of a resource metric.

Optional blobDuration

blobDuration: undefined | string

serializedName

serializedName: string = "MetricAvailability"

Optional timeGrain

timeGrain: undefined | string

type

type: object

className

className: string = "MetricAvailability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

name: "String" = "String"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

Const MetricSpecification

MetricSpecification: object

Definition of a single resource metric.

Optional aggregationType

aggregationType: undefined | string

Optional availabilities

availabilities: MetricAvailability[]

Optional category

category: undefined | string

Optional dimensions

dimensions: Dimension[]

Optional displayDescription

displayDescription: undefined | string

Optional displayName

displayName: undefined | string

Optional enableRegionalMdmAccount

enableRegionalMdmAccount: undefined | false | true

Optional fillGapWithZero

fillGapWithZero: undefined | false | true

Optional isInternal

isInternal: undefined | false | true

Optional metricFilterPattern

metricFilterPattern: undefined | string

Optional name

name: undefined | string

serializedName

serializedName: string = "MetricSpecification"

Optional sourceMdmAccount

sourceMdmAccount: undefined | string

Optional sourceMdmNamespace

sourceMdmNamespace: undefined | string

Optional supportsInstanceLevelAggregation

supportsInstanceLevelAggregation: undefined | false | true

Optional unit

unit: undefined | string

type

type: object

className

className: string = "MetricSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aggregationType

aggregationType: object

serializedName

serializedName: string = "aggregationType"

type

type: object

name

name: "String" = "String"

availabilities

availabilities: object

serializedName

serializedName: string = "availabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricAvailability"

name

name: "Composite" = "Composite"

category

category: object

serializedName

serializedName: string = "category"

type

type: object

name

name: "String" = "String"

dimensions

dimensions: object

serializedName

serializedName: string = "dimensions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Dimension"

name

name: "Composite" = "Composite"

displayDescription

displayDescription: object

serializedName

serializedName: string = "displayDescription"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name: "String" = "String"

enableRegionalMdmAccount

enableRegionalMdmAccount: object

serializedName

serializedName: string = "enableRegionalMdmAccount"

type

type: object

name

name: "Boolean" = "Boolean"

fillGapWithZero

fillGapWithZero: object

serializedName

serializedName: string = "fillGapWithZero"

type

type: object

name

name: "Boolean" = "Boolean"

isInternal

isInternal: object

serializedName

serializedName: string = "isInternal"

type

type: object

name

name: "Boolean" = "Boolean"

metricFilterPattern

metricFilterPattern: object

serializedName

serializedName: string = "metricFilterPattern"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

sourceMdmAccount

sourceMdmAccount: object

serializedName

serializedName: string = "sourceMdmAccount"

type

type: object

name

name: "String" = "String"

sourceMdmNamespace

sourceMdmNamespace: object

serializedName

serializedName: string = "sourceMdmNamespace"

type

type: object

name

name: "String" = "String"

supportsInstanceLevelAggregation

supportsInstanceLevelAggregation: object

serializedName

serializedName: string = "supportsInstanceLevelAggregation"

type

type: object

name

name: "Boolean" = "Boolean"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const MigrateMySqlRequest

MigrateMySqlRequest: object

MySQL migration request.

connectionString

connectionString: string

Connection string to the remote MySQL database.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

migrationType

migrationType: MySqlMigrationType

The type of migration operation to be done. Possible values include: 'LocalToRemote', 'RemoteToLocal'

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MigrateMySqlRequest"

type

type: object

className

className: string = "MigrateMySqlRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "properties.connectionString"

type

type: object

name

name: "String" = "String"

migrationType

migrationType: object

required

required: true = true

serializedName

serializedName: string = "properties.migrationType"

type

type: object

allowedValues

allowedValues: string[] = ["LocalToRemote","RemoteToLocal"]

name

name: "Enum" = "Enum"

Const MigrateMySqlStatus

MigrateMySqlStatus: object

MySQL migration status.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional localMySqlEnabled

localMySqlEnabled: undefined | false | true

True if the web app has in app MySql enabled NOTE: This property will not be serialized. It can only be populated by the server.

Optional migrationOperationStatus

migrationOperationStatus: OperationStatus

Status of the migration task. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created' NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationId

operationId: undefined | string

Operation ID for the migration task. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MigrateMySqlStatus"

type

type: object

className

className: string = "MigrateMySqlStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localMySqlEnabled

localMySqlEnabled: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.localMySqlEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

migrationOperationStatus

migrationOperationStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.migrationOperationStatus"

type

type: object

allowedValues

allowedValues: string[] = ["InProgress","Failed","Succeeded","TimedOut","Created"]

name

name: "Enum" = "Enum"

operationId

operationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operationId"

type

type: object

name

name: "String" = "String"

Const NameIdentifier

NameIdentifier: object

Identifies an object.

Optional name

name: undefined | string

Name of the object.

serializedName

serializedName: string = "NameIdentifier"

type

type: object

className

className: string = "NameIdentifier"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const NameValuePair

NameValuePair: object

Name value pair.

Optional name

name: undefined | string

Pair name.

serializedName

serializedName: string = "NameValuePair"

Optional value

value: undefined | string

Pair value.

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const NetworkAccessControlEntry

NetworkAccessControlEntry: object

Network access control entry.

Optional action

Action object. Possible values include: 'Permit', 'Deny'

Optional description

description: undefined | string

Description of network access control entry.

Optional order

order: undefined | number

Order of precedence.

Optional remoteSubnet

remoteSubnet: undefined | string

Remote subnet.

serializedName

serializedName: string = "NetworkAccessControlEntry"

type

type: object

className

className: string = "NetworkAccessControlEntry"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

action

action: object

serializedName

serializedName: string = "action"

type

type: object

allowedValues

allowedValues: string[] = ["Permit","Deny"]

name

name: "Enum" = "Enum"

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

order

order: object

serializedName

serializedName: string = "order"

type

type: object

name

name: "Number" = "Number"

remoteSubnet

remoteSubnet: object

serializedName

serializedName: string = "remoteSubnet"

type

type: object

name

name: "String" = "String"

Const NetworkFeatures

NetworkFeatures: object

Full view of network features for an app (presently VNET integration and Hybrid Connections).

Optional hybridConnections

hybridConnections: RelayServiceConnectionEntity[]

The Hybrid Connections summary view. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hybridConnectionsV2

hybridConnectionsV2: HybridConnection[]

The Hybrid Connection V2 (Service Bus) view. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkFeatures"

Optional virtualNetworkConnection

virtualNetworkConnection: VnetInfo

The Virtual Network summary view. NOTE: This property will not be serialized. It can only be populated by the server.

Optional virtualNetworkName

virtualNetworkName: undefined | string

The Virtual Network name. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "NetworkFeatures"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hybridConnections

hybridConnections: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hybridConnections"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RelayServiceConnectionEntity"

name

name: "Composite" = "Composite"

hybridConnectionsV2

hybridConnectionsV2: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hybridConnectionsV2"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HybridConnection"

name

name: "Composite" = "Composite"

virtualNetworkConnection

virtualNetworkConnection: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.virtualNetworkConnection"

type

type: object

className

className: string = "VnetInfo"

name

name: "Composite" = "Composite"

virtualNetworkName

virtualNetworkName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.virtualNetworkName"

type

type: object

name

name: "String" = "String"

Const NetworkTrace

NetworkTrace: object

Network trace

Optional message

message: undefined | string

Detailed message of a network trace operation, e.g. error message in case of failure.

Optional path

path: undefined | string

Local file path for the captured network trace file.

serializedName

serializedName: string = "NetworkTrace"

Optional status

status: undefined | string

Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed).

type

type: object

className

className: string = "NetworkTrace"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const Operation

Operation: object

An operation on a resource.

Optional createdTime

createdTime: Date

Time when operation has started.

Optional errors

errors: ErrorEntity[]

Any errors associate with the operation.

Optional expirationTime

expirationTime: Date

Time when operation will expire.

Optional geoMasterOperationId

geoMasterOperationId: undefined | string

Applicable only for stamp operation ids.

Optional id

id: undefined | string

Operation ID.

Optional modifiedTime

modifiedTime: Date

Time when operation has been updated.

Optional name

name: undefined | string

Operation name.

serializedName

serializedName: string = "Operation"

Optional status

The current status of the operation. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created'

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createdTime

createdTime: object

serializedName

serializedName: string = "createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

errors

errors: object

serializedName

serializedName: string = "errors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ErrorEntity"

name

name: "Composite" = "Composite"

expirationTime

expirationTime: object

serializedName

serializedName: string = "expirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

geoMasterOperationId

geoMasterOperationId: object

serializedName

serializedName: string = "geoMasterOperationId"

type

type: object

name

name: "Uuid" = "Uuid"

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

modifiedTime

modifiedTime: object

serializedName

serializedName: string = "modifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["InProgress","Failed","Succeeded","TimedOut","Created"]

name

name: "Enum" = "Enum"

Const PerfMonCounterCollection

PerfMonCounterCollection: object
interface

Collection of performance monitor counters.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PerfMonCounterCollection"

__@iterator

  • __@iterator(): IterableIterator<PerfMonResponse>
  • Iterator

    Returns IterableIterator<PerfMonResponse>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PerfMonResponse>[]): PerfMonResponse[]
  • concat(...items: (T | ConcatArray<T>)[]): PerfMonResponse[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PerfMonResponse>[]

      Additional items to add to the end of array1.

    Returns PerfMonResponse[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PerfMonResponse[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PerfMonResponse]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PerfMonResponse]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PerfMonResponse, index: number, array: PerfMonResponse[]): boolean
        • Parameters

          • value: PerfMonResponse
          • index: number
          • array: PerfMonResponse[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PerfMonResponse, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PerfMonResponse

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PerfMonResponse[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PerfMonResponse

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PerfMonResponse, index: number, array: PerfMonResponse[]): boolean
        • Parameters

          • value: PerfMonResponse
          • index: number
          • array: PerfMonResponse[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PerfMonResponse, index: number, array: PerfMonResponse[]): any
        • Parameters

          • value: PerfMonResponse
          • index: number
          • array: PerfMonResponse[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PerfMonResponse[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PerfMonResponse | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PerfMonResponse

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PerfMonResponse, index: number, obj: PerfMonResponse[]): boolean
        • Parameters

          • this: void
          • value: PerfMonResponse
          • index: number
          • obj: PerfMonResponse[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PerfMonResponse, index: number, obj: PerfMonResponse[]): boolean
        • Parameters

          • value: PerfMonResponse
          • index: number
          • obj: PerfMonResponse[]

          Returns boolean

    • Optional thisArg: any

    Returns PerfMonResponse | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PerfMonResponse, index: number, obj: PerfMonResponse[]): boolean
        • Parameters

          • value: PerfMonResponse
          • index: number
          • obj: PerfMonResponse[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PerfMonResponse, index: number, array: PerfMonResponse[]): void
        • Parameters

          • value: PerfMonResponse
          • index: number
          • array: PerfMonResponse[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PerfMonResponse, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PerfMonResponse

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PerfMonResponse, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PerfMonResponse

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PerfMonResponse, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PerfMonResponse

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PerfMonResponse, index: number, array: PerfMonResponse[]): U
        • Parameters

          • value: PerfMonResponse
          • index: number
          • array: PerfMonResponse[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PerfMonResponse | undefined
  • Removes the last element from an array and returns it.

    Returns PerfMonResponse | undefined

push

  • push(...items: PerfMonResponse[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PerfMonResponse[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PerfMonResponse
  • reduce(callbackfn: function, initialValue: PerfMonResponse): PerfMonResponse
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PerfMonResponse, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): PerfMonResponse
        • Parameters

          • previousValue: PerfMonResponse
          • currentValue: PerfMonResponse
          • currentIndex: number
          • array: PerfMonResponse[]

          Returns PerfMonResponse

    Returns PerfMonResponse

  • Parameters

    • callbackfn: function
        • (previousValue: PerfMonResponse, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): PerfMonResponse
        • Parameters

          • previousValue: PerfMonResponse
          • currentValue: PerfMonResponse
          • currentIndex: number
          • array: PerfMonResponse[]

          Returns PerfMonResponse

    • initialValue: PerfMonResponse

    Returns PerfMonResponse

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): U
        • Parameters

          • previousValue: U
          • currentValue: PerfMonResponse
          • currentIndex: number
          • array: PerfMonResponse[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PerfMonResponse
  • reduceRight(callbackfn: function, initialValue: PerfMonResponse): PerfMonResponse
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PerfMonResponse, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): PerfMonResponse
        • Parameters

          • previousValue: PerfMonResponse
          • currentValue: PerfMonResponse
          • currentIndex: number
          • array: PerfMonResponse[]

          Returns PerfMonResponse

    Returns PerfMonResponse

  • Parameters

    • callbackfn: function
        • (previousValue: PerfMonResponse, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): PerfMonResponse
        • Parameters

          • previousValue: PerfMonResponse
          • currentValue: PerfMonResponse
          • currentIndex: number
          • array: PerfMonResponse[]

          Returns PerfMonResponse

    • initialValue: PerfMonResponse

    Returns PerfMonResponse

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): U
        • Parameters

          • previousValue: U
          • currentValue: PerfMonResponse
          • currentIndex: number
          • array: PerfMonResponse[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PerfMonResponse[]
  • Reverses the elements in an Array.

    Returns PerfMonResponse[]

shift

  • shift(): PerfMonResponse | undefined
  • Removes the first element from an array and returns it.

    Returns PerfMonResponse | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PerfMonResponse[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PerfMonResponse[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PerfMonResponse, index: number, array: PerfMonResponse[]): boolean
        • Parameters

          • value: PerfMonResponse
          • index: number
          • array: PerfMonResponse[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PerfMonResponse[]
  • splice(start: number, deleteCount: number, ...items: PerfMonResponse[]): PerfMonResponse[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PerfMonResponse[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PerfMonResponse[]

      Elements to insert into the array in place of the deleted elements.

    Returns PerfMonResponse[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PerfMonResponse[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PerfMonResponse[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PerfMonResponse>
  • Returns an iterable of values in the array

    Returns IterableIterator<PerfMonResponse>

type

type: object

className

className: string = "PerfMonCounterCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PerfMonResponse"

name

name: "Composite" = "Composite"

Const PerfMonResponse

PerfMonResponse: object

Performance monitor API response.

Optional code

code: undefined | string

The response code.

Optional data

The performance monitor counters.

Optional message

message: undefined | string

The message.

serializedName

serializedName: string = "PerfMonResponse"

type

type: object

className

className: string = "PerfMonResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

data

data: object

serializedName

serializedName: string = "data"

type

type: object

className

className: string = "PerfMonSet"

name

name: "Composite" = "Composite"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const PerfMonSample

PerfMonSample: object

Performance monitor sample in a set.

Optional instanceName

instanceName: undefined | string

Name of the server on which the measurement is made.

serializedName

serializedName: string = "PerfMonSample"

Optional time

time: Date

Point in time for which counter was measured.

Optional value

value: undefined | number

Value of counter at a certain time.

type

type: object

className

className: string = "PerfMonSample"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

instanceName

instanceName: object

serializedName

serializedName: string = "instanceName"

type

type: object

name

name: "String" = "String"

time

time: object

serializedName

serializedName: string = "time"

type

type: object

name

name: "DateTime" = "DateTime"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Number" = "Number"

Const PerfMonSet

PerfMonSet: object

Metric information.

Optional endTime

endTime: Date

End time of the period.

Optional name

name: undefined | string

Unique key name of the counter.

serializedName

serializedName: string = "PerfMonSet"

Optional startTime

startTime: Date

Start time of the period.

Optional timeGrain

timeGrain: undefined | string

Presented time grain.

Optional values

values: PerfMonSample[]

Collection of workers that are active during this time.

type

type: object

className

className: string = "PerfMonSet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

values

values: object

serializedName

serializedName: string = "values"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PerfMonSample"

name

name: "Composite" = "Composite"

Const PremierAddOn

PremierAddOn: object

Premier add-on.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

location

location: string

Resource Location.

Optional marketplaceOffer

marketplaceOffer: undefined | string

Premier add on Marketplace offer.

Optional marketplacePublisher

marketplacePublisher: undefined | string

Premier add on Marketplace publisher.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional product

product: undefined | string

Premier add on Product.

serializedName

serializedName: string = "PremierAddOn"

Optional sku

sku: undefined | string

Premier add on SKU.

Optional tags

tags: undefined | object

Resource tags.

Optional vendor

vendor: undefined | string

Premier add on Vendor.

type

type: object

className

className: string = "PremierAddOn"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

marketplaceOffer

marketplaceOffer: object

serializedName

serializedName: string = "properties.marketplaceOffer"

type

type: object

name

name: "String" = "String"

marketplacePublisher

marketplacePublisher: object

serializedName

serializedName: string = "properties.marketplacePublisher"

type

type: object

name

name: "String" = "String"

product

product: object

serializedName

serializedName: string = "properties.product"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

name

name: "String" = "String"

vendor

vendor: object

serializedName

serializedName: string = "properties.vendor"

type

type: object

name

name: "String" = "String"

Const PremierAddOnOffer

PremierAddOnOffer: object

Premier add-on offer.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional legalTermsUrl

legalTermsUrl: undefined | string

Legal terms URL.

Optional marketplaceOffer

marketplaceOffer: undefined | string

Marketplace offer.

Optional marketplacePublisher

marketplacePublisher: undefined | string

Marketplace publisher.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privacyPolicyUrl

privacyPolicyUrl: undefined | string

Privacy policy URL.

Optional product

product: undefined | string

Premier add on offer Product.

Optional promoCodeRequired

promoCodeRequired: undefined | false | true

true if promotion code is required; otherwise, false.

Optional quota

quota: undefined | number

Premier add on offer Quota.

serializedName

serializedName: string = "PremierAddOnOffer"

Optional sku

sku: undefined | string

Premier add on SKU.

Optional vendor

vendor: undefined | string

Premier add on offer Vendor.

Optional webHostingPlanRestrictions

webHostingPlanRestrictions: AppServicePlanRestrictions

App Service plans this offer is restricted to. Possible values include: 'None', 'Free', 'Shared', 'Basic', 'Standard', 'Premium'

type

type: object

className

className: string = "PremierAddOnOffer"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

legalTermsUrl

legalTermsUrl: object

serializedName

serializedName: string = "properties.legalTermsUrl"

type

type: object

name

name: "String" = "String"

marketplaceOffer

marketplaceOffer: object

serializedName

serializedName: string = "properties.marketplaceOffer"

type

type: object

name

name: "String" = "String"

marketplacePublisher

marketplacePublisher: object

serializedName

serializedName: string = "properties.marketplacePublisher"

type

type: object

name

name: "String" = "String"

privacyPolicyUrl

privacyPolicyUrl: object

serializedName

serializedName: string = "properties.privacyPolicyUrl"

type

type: object

name

name: "String" = "String"

product

product: object

serializedName

serializedName: string = "properties.product"

type

type: object

name

name: "String" = "String"

promoCodeRequired

promoCodeRequired: object

serializedName

serializedName: string = "properties.promoCodeRequired"

type

type: object

name

name: "Boolean" = "Boolean"

quota

quota: object

serializedName

serializedName: string = "properties.quota"

type

type: object

name

name: "Number" = "Number"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

name

name: "String" = "String"

vendor

vendor: object

serializedName

serializedName: string = "properties.vendor"

type

type: object

name

name: "String" = "String"

webHostingPlanRestrictions

webHostingPlanRestrictions: object

serializedName

serializedName: string = "properties.webHostingPlanRestrictions"

type

type: object

allowedValues

allowedValues: string[] = ["None","Free","Shared","Basic","Standard","Premium"]

name

name: "Enum" = "Enum"

Const PremierAddOnOfferCollection

PremierAddOnOfferCollection: object
interface

Collection of premier add-on offers.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PremierAddOnOfferCollection"

__@iterator

  • __@iterator(): IterableIterator<PremierAddOnOffer>
  • Iterator

    Returns IterableIterator<PremierAddOnOffer>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PremierAddOnOffer>[]): PremierAddOnOffer[]
  • concat(...items: (T | ConcatArray<T>)[]): PremierAddOnOffer[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PremierAddOnOffer>[]

      Additional items to add to the end of array1.

    Returns PremierAddOnOffer[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PremierAddOnOffer[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PremierAddOnOffer]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PremierAddOnOffer]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): boolean
        • Parameters

          • value: PremierAddOnOffer
          • index: number
          • array: PremierAddOnOffer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PremierAddOnOffer, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PremierAddOnOffer

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PremierAddOnOffer[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PremierAddOnOffer

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): boolean
        • Parameters

          • value: PremierAddOnOffer
          • index: number
          • array: PremierAddOnOffer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): any
        • Parameters

          • value: PremierAddOnOffer
          • index: number
          • array: PremierAddOnOffer[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PremierAddOnOffer[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PremierAddOnOffer | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PremierAddOnOffer

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PremierAddOnOffer, index: number, obj: PremierAddOnOffer[]): boolean
        • Parameters

          • this: void
          • value: PremierAddOnOffer
          • index: number
          • obj: PremierAddOnOffer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PremierAddOnOffer, index: number, obj: PremierAddOnOffer[]): boolean
        • Parameters

          • value: PremierAddOnOffer
          • index: number
          • obj: PremierAddOnOffer[]

          Returns boolean

    • Optional thisArg: any

    Returns PremierAddOnOffer | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PremierAddOnOffer, index: number, obj: PremierAddOnOffer[]): boolean
        • Parameters

          • value: PremierAddOnOffer
          • index: number
          • obj: PremierAddOnOffer[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): void
        • Parameters

          • value: PremierAddOnOffer
          • index: number
          • array: PremierAddOnOffer[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PremierAddOnOffer, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PremierAddOnOffer

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PremierAddOnOffer, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PremierAddOnOffer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PremierAddOnOffer, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PremierAddOnOffer

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): U
        • Parameters

          • value: PremierAddOnOffer
          • index: number
          • array: PremierAddOnOffer[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PremierAddOnOffer | undefined
  • Removes the last element from an array and returns it.

    Returns PremierAddOnOffer | undefined

push

  • push(...items: PremierAddOnOffer[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PremierAddOnOffer[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PremierAddOnOffer
  • reduce(callbackfn: function, initialValue: PremierAddOnOffer): PremierAddOnOffer
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PremierAddOnOffer, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): PremierAddOnOffer
        • Parameters

          • previousValue: PremierAddOnOffer
          • currentValue: PremierAddOnOffer
          • currentIndex: number
          • array: PremierAddOnOffer[]

          Returns PremierAddOnOffer

    Returns PremierAddOnOffer

  • Parameters

    • callbackfn: function
        • (previousValue: PremierAddOnOffer, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): PremierAddOnOffer
        • Parameters

          • previousValue: PremierAddOnOffer
          • currentValue: PremierAddOnOffer
          • currentIndex: number
          • array: PremierAddOnOffer[]

          Returns PremierAddOnOffer

    • initialValue: PremierAddOnOffer

    Returns PremierAddOnOffer

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): U
        • Parameters

          • previousValue: U
          • currentValue: PremierAddOnOffer
          • currentIndex: number
          • array: PremierAddOnOffer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PremierAddOnOffer
  • reduceRight(callbackfn: function, initialValue: PremierAddOnOffer): PremierAddOnOffer
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PremierAddOnOffer, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): PremierAddOnOffer
        • Parameters

          • previousValue: PremierAddOnOffer
          • currentValue: PremierAddOnOffer
          • currentIndex: number
          • array: PremierAddOnOffer[]

          Returns PremierAddOnOffer

    Returns PremierAddOnOffer

  • Parameters

    • callbackfn: function
        • (previousValue: PremierAddOnOffer, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): PremierAddOnOffer
        • Parameters

          • previousValue: PremierAddOnOffer
          • currentValue: PremierAddOnOffer
          • currentIndex: number
          • array: PremierAddOnOffer[]

          Returns PremierAddOnOffer

    • initialValue: PremierAddOnOffer

    Returns PremierAddOnOffer

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): U
        • Parameters

          • previousValue: U
          • currentValue: PremierAddOnOffer
          • currentIndex: number
          • array: PremierAddOnOffer[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PremierAddOnOffer[]
  • Reverses the elements in an Array.

    Returns PremierAddOnOffer[]

shift

  • shift(): PremierAddOnOffer | undefined
  • Removes the first element from an array and returns it.

    Returns PremierAddOnOffer | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PremierAddOnOffer[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PremierAddOnOffer[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): boolean
        • Parameters

          • value: PremierAddOnOffer
          • index: number
          • array: PremierAddOnOffer[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PremierAddOnOffer[]
  • splice(start: number, deleteCount: number, ...items: PremierAddOnOffer[]): PremierAddOnOffer[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PremierAddOnOffer[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PremierAddOnOffer[]

      Elements to insert into the array in place of the deleted elements.

    Returns PremierAddOnOffer[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PremierAddOnOffer[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PremierAddOnOffer[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PremierAddOnOffer>
  • Returns an iterable of values in the array

    Returns IterableIterator<PremierAddOnOffer>

type

type: object

className

className: string = "PremierAddOnOfferCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PremierAddOnOffer"

name

name: "Composite" = "Composite"

Const PremierAddOnPatchResource

PremierAddOnPatchResource: object

ARM resource for a PremierAddOn.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional marketplaceOffer

marketplaceOffer: undefined | string

Premier add on Marketplace offer.

Optional marketplacePublisher

marketplacePublisher: undefined | string

Premier add on Marketplace publisher.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional product

product: undefined | string

Premier add on Product.

serializedName

serializedName: string = "PremierAddOnPatchResource"

Optional sku

sku: undefined | string

Premier add on SKU.

Optional vendor

vendor: undefined | string

Premier add on Vendor.

type

type: object

className

className: string = "PremierAddOnPatchResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

marketplaceOffer

marketplaceOffer: object

serializedName

serializedName: string = "properties.marketplaceOffer"

type

type: object

name

name: "String" = "String"

marketplacePublisher

marketplacePublisher: object

serializedName

serializedName: string = "properties.marketplacePublisher"

type

type: object

name

name: "String" = "String"

product

product: object

serializedName

serializedName: string = "properties.product"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

name

name: "String" = "String"

vendor

vendor: object

serializedName

serializedName: string = "properties.vendor"

type

type: object

name

name: "String" = "String"

Const PrivateAccess

PrivateAccess: object

Description of the parameters of Private Access for a Web Site.

Optional enabled

enabled: undefined | false | true

Whether private access is enabled or not.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PrivateAccess"

Optional virtualNetworks

virtualNetworks: PrivateAccessVirtualNetwork[]

The Virtual Networks (and subnets) allowed to access the site privately.

type

type: object

className

className: string = "PrivateAccess"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

virtualNetworks

virtualNetworks: object

serializedName

serializedName: string = "properties.virtualNetworks"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PrivateAccessVirtualNetwork"

name

name: "Composite" = "Composite"

Const PrivateAccessSubnet

PrivateAccessSubnet: object

Description of a Virtual Network subnet that is useable for private site access.

Optional key

key: undefined | number

The key (ID) of the subnet.

Optional name

name: undefined | string

The name of the subnet.

serializedName

serializedName: string = "PrivateAccessSubnet"

type

type: object

className

className: string = "PrivateAccessSubnet"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "key"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const PrivateAccessVirtualNetwork

PrivateAccessVirtualNetwork: object

Description of a Virtual Network that is useable for private site access.

Optional key

key: undefined | number

The key (ID) of the Virtual Network.

Optional name

name: undefined | string

The name of the Virtual Network.

Optional resourceId

resourceId: undefined | string

The ARM uri of the Virtual Network

serializedName

serializedName: string = "PrivateAccessVirtualNetwork"

Optional subnets

subnets: PrivateAccessSubnet[]

A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.

type

type: object

className

className: string = "PrivateAccessVirtualNetwork"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "key"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

resourceId

resourceId: object

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

subnets

subnets: object

serializedName

serializedName: string = "subnets"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PrivateAccessSubnet"

name

name: "Composite" = "Composite"

Const ProcessInfo

ProcessInfo: object

Process Information.

Optional children

children: string[]

Child process list.

Optional commandLine

commandLine: undefined | string

Command line.

Optional deploymentName

deploymentName: undefined | string

Deployment name.

Optional description

description: undefined | string

Description of process.

Optional environmentVariables

environmentVariables: undefined | object

List of environment variables.

Optional fileName

fileName: undefined | string

File name of this process.

Optional handleCount

handleCount: undefined | number

Handle count.

Optional href

href: undefined | string

HRef URI.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identifier

identifier: undefined | number

ARM Identifier for deployment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional iisProfileTimeoutInSeconds

iisProfileTimeoutInSeconds: undefined | number

IIS Profile timeout (seconds).

Optional isIisProfileRunning

isIisProfileRunning: undefined | false | true

Is the IIS Profile running?

Optional isProfileRunning

isProfileRunning: undefined | false | true

Is profile running?

Optional isScmSite

isScmSite: undefined | false | true

Is this the SCM site?

Optional isWebjob

isWebjob: undefined | false | true

Is this a Web Job?

Optional kind

kind: undefined | string

Kind of resource.

Optional minidump

minidump: undefined | string

Minidump URI.

Optional moduleCount

moduleCount: undefined | number

Module count.

Optional modules

modules: ProcessModuleInfo[]

List of modules.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nonPagedSystemMemory

nonPagedSystemMemory: undefined | number

Non-paged system memory.

Optional openFileHandles

openFileHandles: string[]

List of open files.

Optional pagedMemory

pagedMemory: undefined | number

Paged memory.

Optional pagedSystemMemory

pagedSystemMemory: undefined | number

Paged system memory.

Optional parent

parent: undefined | string

Parent process.

Optional peakPagedMemory

peakPagedMemory: undefined | number

Peak paged memory.

Optional peakVirtualMemory

peakVirtualMemory: undefined | number

Peak virtual memory usage.

Optional peakWorkingSet

peakWorkingSet: undefined | number

Peak working set.

Optional privateMemory

privateMemory: undefined | number

Private memory size.

Optional privilegedCpuTime

privilegedCpuTime: undefined | string

Privileged CPU time.

serializedName

serializedName: string = "ProcessInfo"

Optional startTime

startTime: Date

Start time.

Optional threadCount

threadCount: undefined | number

Thread count.

Optional threads

threads: ProcessThreadInfo[]

Thread list.

Optional timeStamp

timeStamp: Date

Time stamp.

Optional totalCpuTime

totalCpuTime: undefined | string

Total CPU time.

Optional userCpuTime

userCpuTime: undefined | string

User CPU time.

Optional userName

userName: undefined | string

User name.

Optional virtualMemory

virtualMemory: undefined | number

Virtual memory size.

Optional workingSet

workingSet: undefined | number

Working set.

type

type: object

className

className: string = "ProcessInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

children

children: object

serializedName

serializedName: string = "properties.children"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

commandLine

commandLine: object

serializedName

serializedName: string = "properties.command_line"

type

type: object

name

name: "String" = "String"

deploymentName

deploymentName: object

serializedName

serializedName: string = "properties.deployment_name"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

environmentVariables

environmentVariables: object

serializedName

serializedName: string = "properties.environment_variables"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

fileName

fileName: object

serializedName

serializedName: string = "properties.file_name"

type

type: object

name

name: "String" = "String"

handleCount

handleCount: object

serializedName

serializedName: string = "properties.handle_count"

type

type: object

name

name: "Number" = "Number"

href

href: object

serializedName

serializedName: string = "properties.href"

type

type: object

name

name: "String" = "String"

identifier

identifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.identifier"

type

type: object

name

name: "Number" = "Number"

iisProfileTimeoutInSeconds

iisProfileTimeoutInSeconds: object

serializedName

serializedName: string = "properties.iis_profile_timeout_in_seconds"

type

type: object

name

name: "Number" = "Number"

isIisProfileRunning

isIisProfileRunning: object

serializedName

serializedName: string = "properties.is_iis_profile_running"

type

type: object

name

name: "Boolean" = "Boolean"

isProfileRunning

isProfileRunning: object

serializedName

serializedName: string = "properties.is_profile_running"

type

type: object

name

name: "Boolean" = "Boolean"

isScmSite

isScmSite: object

serializedName

serializedName: string = "properties.is_scm_site"

type

type: object

name

name: "Boolean" = "Boolean"

isWebjob

isWebjob: object

serializedName

serializedName: string = "properties.is_webjob"

type

type: object

name

name: "Boolean" = "Boolean"

minidump

minidump: object

serializedName

serializedName: string = "properties.minidump"

type

type: object

name

name: "String" = "String"

moduleCount

moduleCount: object

serializedName

serializedName: string = "properties.module_count"

type

type: object

name

name: "Number" = "Number"

modules

modules: object

serializedName

serializedName: string = "properties.modules"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProcessModuleInfo"

name

name: "Composite" = "Composite"

nonPagedSystemMemory

nonPagedSystemMemory: object

serializedName

serializedName: string = "properties.non_paged_system_memory"

type

type: object

name

name: "Number" = "Number"

openFileHandles

openFileHandles: object

serializedName

serializedName: string = "properties.open_file_handles"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

pagedMemory

pagedMemory: object

serializedName

serializedName: string = "properties.paged_memory"

type

type: object

name

name: "Number" = "Number"

pagedSystemMemory

pagedSystemMemory: object

serializedName

serializedName: string = "properties.paged_system_memory"

type

type: object

name

name: "Number" = "Number"

parent

parent: object

serializedName

serializedName: string = "properties.parent"

type

type: object

name

name: "String" = "String"

peakPagedMemory

peakPagedMemory: object

serializedName

serializedName: string = "properties.peak_paged_memory"

type

type: object

name

name: "Number" = "Number"

peakVirtualMemory

peakVirtualMemory: object

serializedName

serializedName: string = "properties.peak_virtual_memory"

type

type: object

name

name: "Number" = "Number"

peakWorkingSet

peakWorkingSet: object

serializedName

serializedName: string = "properties.peak_working_set"

type

type: object

name

name: "Number" = "Number"

privateMemory

privateMemory: object

serializedName

serializedName: string = "properties.private_memory"

type

type: object

name

name: "Number" = "Number"

privilegedCpuTime

privilegedCpuTime: object

serializedName

serializedName: string = "properties.privileged_cpu_time"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "properties.start_time"

type

type: object

name

name: "DateTime" = "DateTime"

threadCount

threadCount: object

serializedName

serializedName: string = "properties.thread_count"

type

type: object

name

name: "Number" = "Number"

threads

threads: object

serializedName

serializedName: string = "properties.threads"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProcessThreadInfo"

name

name: "Composite" = "Composite"

timeStamp

timeStamp: object

serializedName

serializedName: string = "properties.time_stamp"

type

type: object

name

name: "DateTime" = "DateTime"

totalCpuTime

totalCpuTime: object

serializedName

serializedName: string = "properties.total_cpu_time"

type

type: object

name

name: "String" = "String"

userCpuTime

userCpuTime: object

serializedName

serializedName: string = "properties.user_cpu_time"

type

type: object

name

name: "String" = "String"

userName

userName: object

serializedName

serializedName: string = "properties.user_name"

type

type: object

name

name: "String" = "String"

virtualMemory

virtualMemory: object

serializedName

serializedName: string = "properties.virtual_memory"

type

type: object

name

name: "Number" = "Number"

workingSet

workingSet: object

serializedName

serializedName: string = "properties.working_set"

type

type: object

name

name: "Number" = "Number"

Const ProcessInfoCollection

ProcessInfoCollection: object
interface

Collection of Kudu process information elements.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProcessInfoCollection"

__@iterator

  • __@iterator(): IterableIterator<ProcessInfo>
  • Iterator

    Returns IterableIterator<ProcessInfo>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ProcessInfo>[]): ProcessInfo[]
  • concat(...items: (T | ConcatArray<T>)[]): ProcessInfo[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProcessInfo>[]

      Additional items to add to the end of array1.

    Returns ProcessInfo[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProcessInfo[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ProcessInfo]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProcessInfo]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ProcessInfo, index: number, array: ProcessInfo[]): boolean
        • Parameters

          • value: ProcessInfo
          • index: number
          • array: ProcessInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProcessInfo, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProcessInfo

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProcessInfo[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ProcessInfo

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProcessInfo, index: number, array: ProcessInfo[]): boolean
        • Parameters

          • value: ProcessInfo
          • index: number
          • array: ProcessInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProcessInfo, index: number, array: ProcessInfo[]): any
        • Parameters

          • value: ProcessInfo
          • index: number
          • array: ProcessInfo[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProcessInfo[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProcessInfo | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ProcessInfo

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ProcessInfo, index: number, obj: ProcessInfo[]): boolean
        • Parameters

          • this: void
          • value: ProcessInfo
          • index: number
          • obj: ProcessInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ProcessInfo, index: number, obj: ProcessInfo[]): boolean
        • Parameters

          • value: ProcessInfo
          • index: number
          • obj: ProcessInfo[]

          Returns boolean

    • Optional thisArg: any

    Returns ProcessInfo | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ProcessInfo, index: number, obj: ProcessInfo[]): boolean
        • Parameters

          • value: ProcessInfo
          • index: number
          • obj: ProcessInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ProcessInfo, index: number, array: ProcessInfo[]): void
        • Parameters

          • value: ProcessInfo
          • index: number
          • array: ProcessInfo[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProcessInfo, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProcessInfo

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProcessInfo, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProcessInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProcessInfo, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProcessInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ProcessInfo, index: number, array: ProcessInfo[]): U
        • Parameters

          • value: ProcessInfo
          • index: number
          • array: ProcessInfo[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ProcessInfo | undefined
  • Removes the last element from an array and returns it.

    Returns ProcessInfo | undefined

push

  • push(...items: ProcessInfo[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ProcessInfo[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ProcessInfo
  • reduce(callbackfn: function, initialValue: ProcessInfo): ProcessInfo
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProcessInfo, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): ProcessInfo
        • Parameters

          • previousValue: ProcessInfo
          • currentValue: ProcessInfo
          • currentIndex: number
          • array: ProcessInfo[]

          Returns ProcessInfo

    Returns ProcessInfo

  • Parameters

    • callbackfn: function
        • (previousValue: ProcessInfo, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): ProcessInfo
        • Parameters

          • previousValue: ProcessInfo
          • currentValue: ProcessInfo
          • currentIndex: number
          • array: ProcessInfo[]

          Returns ProcessInfo

    • initialValue: ProcessInfo

    Returns ProcessInfo

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: ProcessInfo
          • currentIndex: number
          • array: ProcessInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ProcessInfo
  • reduceRight(callbackfn: function, initialValue: ProcessInfo): ProcessInfo
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProcessInfo, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): ProcessInfo
        • Parameters

          • previousValue: ProcessInfo
          • currentValue: ProcessInfo
          • currentIndex: number
          • array: ProcessInfo[]

          Returns ProcessInfo

    Returns ProcessInfo

  • Parameters

    • callbackfn: function
        • (previousValue: ProcessInfo, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): ProcessInfo
        • Parameters

          • previousValue: ProcessInfo
          • currentValue: ProcessInfo
          • currentIndex: number
          • array: ProcessInfo[]

          Returns ProcessInfo

    • initialValue: ProcessInfo

    Returns ProcessInfo

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: ProcessInfo
          • currentIndex: number
          • array: ProcessInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ProcessInfo[]
  • Reverses the elements in an Array.

    Returns ProcessInfo[]

shift

  • shift(): ProcessInfo | undefined
  • Removes the first element from an array and returns it.

    Returns ProcessInfo | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProcessInfo[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProcessInfo[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ProcessInfo, index: number, array: ProcessInfo[]): boolean
        • Parameters

          • value: ProcessInfo
          • index: number
          • array: ProcessInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ProcessInfo[]
  • splice(start: number, deleteCount: number, ...items: ProcessInfo[]): ProcessInfo[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProcessInfo[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProcessInfo[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProcessInfo[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ProcessInfo[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProcessInfo[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ProcessInfo>
  • Returns an iterable of values in the array

    Returns IterableIterator<ProcessInfo>

type

type: object

className

className: string = "ProcessInfoCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProcessInfo"

name

name: "Composite" = "Composite"

Const ProcessModuleInfo

ProcessModuleInfo: object

Process Module Information.

Optional baseAddress

baseAddress: undefined | string

Base address. Used as module identifier in ARM resource URI.

Optional fileDescription

fileDescription: undefined | string

File description.

Optional fileName

fileName: undefined | string

File name.

Optional filePath

filePath: undefined | string

File path.

Optional fileVersion

fileVersion: undefined | string

File version.

Optional href

href: undefined | string

HRef URI.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDebug

isDebug: undefined | false | true

Is debug?

Optional kind

kind: undefined | string

Kind of resource.

Optional language

language: undefined | string

Module language (locale).

Optional moduleMemorySize

moduleMemorySize: undefined | number

Module memory size.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional product

product: undefined | string

Product name.

Optional productVersion

productVersion: undefined | string

Product version.

serializedName

serializedName: string = "ProcessModuleInfo"

type

type: object

className

className: string = "ProcessModuleInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

baseAddress

baseAddress: object

serializedName

serializedName: string = "properties.base_address"

type

type: object

name

name: "String" = "String"

fileDescription

fileDescription: object

serializedName

serializedName: string = "properties.file_description"

type

type: object

name

name: "String" = "String"

fileName

fileName: object

serializedName

serializedName: string = "properties.file_name"

type

type: object

name

name: "String" = "String"

filePath

filePath: object

serializedName

serializedName: string = "properties.file_path"

type

type: object

name

name: "String" = "String"

fileVersion

fileVersion: object

serializedName

serializedName: string = "properties.file_version"

type

type: object

name

name: "String" = "String"

href

href: object

serializedName

serializedName: string = "properties.href"

type

type: object

name

name: "String" = "String"

isDebug

isDebug: object

serializedName

serializedName: string = "properties.is_debug"

type

type: object

name

name: "Boolean" = "Boolean"

language

language: object

serializedName

serializedName: string = "properties.language"

type

type: object

name

name: "String" = "String"

moduleMemorySize

moduleMemorySize: object

serializedName

serializedName: string = "properties.module_memory_size"

type

type: object

name

name: "Number" = "Number"

product

product: object

serializedName

serializedName: string = "properties.product"

type

type: object

name

name: "String" = "String"

productVersion

productVersion: object

serializedName

serializedName: string = "properties.product_version"

type

type: object

name

name: "String" = "String"

Const ProcessModuleInfoCollection

ProcessModuleInfoCollection: object
interface

Collection of Kudu thread information elements.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProcessModuleInfoCollection"

__@iterator

  • __@iterator(): IterableIterator<ProcessModuleInfo>
  • Iterator

    Returns IterableIterator<ProcessModuleInfo>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ProcessModuleInfo>[]): ProcessModuleInfo[]
  • concat(...items: (T | ConcatArray<T>)[]): ProcessModuleInfo[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProcessModuleInfo>[]

      Additional items to add to the end of array1.

    Returns ProcessModuleInfo[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProcessModuleInfo[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ProcessModuleInfo]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProcessModuleInfo]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): boolean
        • Parameters

          • value: ProcessModuleInfo
          • index: number
          • array: ProcessModuleInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProcessModuleInfo, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProcessModuleInfo

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProcessModuleInfo[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ProcessModuleInfo

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): boolean
        • Parameters

          • value: ProcessModuleInfo
          • index: number
          • array: ProcessModuleInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): any
        • Parameters

          • value: ProcessModuleInfo
          • index: number
          • array: ProcessModuleInfo[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProcessModuleInfo[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProcessModuleInfo | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ProcessModuleInfo

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ProcessModuleInfo, index: number, obj: ProcessModuleInfo[]): boolean
        • Parameters

          • this: void
          • value: ProcessModuleInfo
          • index: number
          • obj: ProcessModuleInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ProcessModuleInfo, index: number, obj: ProcessModuleInfo[]): boolean
        • Parameters

          • value: ProcessModuleInfo
          • index: number
          • obj: ProcessModuleInfo[]

          Returns boolean

    • Optional thisArg: any

    Returns ProcessModuleInfo | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ProcessModuleInfo, index: number, obj: ProcessModuleInfo[]): boolean
        • Parameters

          • value: ProcessModuleInfo
          • index: number
          • obj: ProcessModuleInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): void
        • Parameters

          • value: ProcessModuleInfo
          • index: number
          • array: ProcessModuleInfo[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProcessModuleInfo, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProcessModuleInfo

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProcessModuleInfo, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProcessModuleInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProcessModuleInfo, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProcessModuleInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): U
        • Parameters

          • value: ProcessModuleInfo
          • index: number
          • array: ProcessModuleInfo[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ProcessModuleInfo | undefined
  • Removes the last element from an array and returns it.

    Returns ProcessModuleInfo | undefined

push

  • push(...items: ProcessModuleInfo[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ProcessModuleInfo[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ProcessModuleInfo
  • reduce(callbackfn: function, initialValue: ProcessModuleInfo): ProcessModuleInfo
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProcessModuleInfo, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): ProcessModuleInfo
        • Parameters

          • previousValue: ProcessModuleInfo
          • currentValue: ProcessModuleInfo
          • currentIndex: number
          • array: ProcessModuleInfo[]

          Returns ProcessModuleInfo

    Returns ProcessModuleInfo

  • Parameters

    • callbackfn: function
        • (previousValue: ProcessModuleInfo, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): ProcessModuleInfo
        • Parameters

          • previousValue: ProcessModuleInfo
          • currentValue: ProcessModuleInfo
          • currentIndex: number
          • array: ProcessModuleInfo[]

          Returns ProcessModuleInfo

    • initialValue: ProcessModuleInfo

    Returns ProcessModuleInfo

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: ProcessModuleInfo
          • currentIndex: number
          • array: ProcessModuleInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ProcessModuleInfo
  • reduceRight(callbackfn: function, initialValue: ProcessModuleInfo): ProcessModuleInfo
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProcessModuleInfo, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): ProcessModuleInfo
        • Parameters

          • previousValue: ProcessModuleInfo
          • currentValue: ProcessModuleInfo
          • currentIndex: number
          • array: ProcessModuleInfo[]

          Returns ProcessModuleInfo

    Returns ProcessModuleInfo

  • Parameters

    • callbackfn: function
        • (previousValue: ProcessModuleInfo, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): ProcessModuleInfo
        • Parameters

          • previousValue: ProcessModuleInfo
          • currentValue: ProcessModuleInfo
          • currentIndex: number
          • array: ProcessModuleInfo[]

          Returns ProcessModuleInfo

    • initialValue: ProcessModuleInfo

    Returns ProcessModuleInfo

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: ProcessModuleInfo
          • currentIndex: number
          • array: ProcessModuleInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ProcessModuleInfo[]
  • Reverses the elements in an Array.

    Returns ProcessModuleInfo[]

shift

  • shift(): ProcessModuleInfo | undefined
  • Removes the first element from an array and returns it.

    Returns ProcessModuleInfo | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProcessModuleInfo[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProcessModuleInfo[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): boolean
        • Parameters

          • value: ProcessModuleInfo
          • index: number
          • array: ProcessModuleInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ProcessModuleInfo[]
  • splice(start: number, deleteCount: number, ...items: ProcessModuleInfo[]): ProcessModuleInfo[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProcessModuleInfo[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProcessModuleInfo[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProcessModuleInfo[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ProcessModuleInfo[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProcessModuleInfo[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ProcessModuleInfo>
  • Returns an iterable of values in the array

    Returns IterableIterator<ProcessModuleInfo>

type

type: object

className

className: string = "ProcessModuleInfoCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProcessModuleInfo"

name

name: "Composite" = "Composite"

Const ProcessThreadInfo

ProcessThreadInfo: object

Process Thread Information.

Optional basePriority

basePriority: undefined | number

Base priority.

Optional currentPriority

currentPriority: undefined | number

Current thread priority.

Optional href

href: undefined | string

HRef URI.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identifier

identifier: undefined | number

Site extension ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional priorityLevel

priorityLevel: undefined | string

Thread priority level.

Optional priviledgedProcessorTime

priviledgedProcessorTime: undefined | string

Privileged processor time.

Optional process

process: undefined | string

Process URI.

serializedName

serializedName: string = "ProcessThreadInfo"

Optional startAddress

startAddress: undefined | string

Start address.

Optional startTime

startTime: Date

Start time.

Optional state

state: undefined | string

Thread state.

Optional totalProcessorTime

totalProcessorTime: undefined | string

Total processor time.

Optional userProcessorTime

userProcessorTime: undefined | string

User processor time.

Optional waitReason

waitReason: undefined | string

Wait reason.

type

type: object

className

className: string = "ProcessThreadInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

basePriority

basePriority: object

serializedName

serializedName: string = "properties.base_priority"

type

type: object

name

name: "Number" = "Number"

currentPriority

currentPriority: object

serializedName

serializedName: string = "properties.current_priority"

type

type: object

name

name: "Number" = "Number"

href

href: object

serializedName

serializedName: string = "properties.href"

type

type: object

name

name: "String" = "String"

identifier

identifier: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.identifier"

type

type: object

name

name: "Number" = "Number"

priorityLevel

priorityLevel: object

serializedName

serializedName: string = "properties.priority_level"

type

type: object

name

name: "String" = "String"

priviledgedProcessorTime

priviledgedProcessorTime: object

serializedName

serializedName: string = "properties.priviledged_processor_time"

type

type: object

name

name: "String" = "String"

process

process: object

serializedName

serializedName: string = "properties.process"

type

type: object

name

name: "String" = "String"

startAddress

startAddress: object

serializedName

serializedName: string = "properties.start_address"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "properties.start_time"

type

type: object

name

name: "DateTime" = "DateTime"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

totalProcessorTime

totalProcessorTime: object

serializedName

serializedName: string = "properties.total_processor_time"

type

type: object

name

name: "String" = "String"

userProcessorTime

userProcessorTime: object

serializedName

serializedName: string = "properties.user_processor_time"

type

type: object

name

name: "String" = "String"

waitReason

waitReason: object

serializedName

serializedName: string = "properties.wait_reason"

type

type: object

name

name: "String" = "String"

Const ProcessThreadInfoCollection

ProcessThreadInfoCollection: object
interface

Collection of Kudu thread information elements.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProcessThreadInfoCollection"

__@iterator

  • __@iterator(): IterableIterator<ProcessThreadInfo>
  • Iterator

    Returns IterableIterator<ProcessThreadInfo>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ProcessThreadInfo>[]): ProcessThreadInfo[]
  • concat(...items: (T | ConcatArray<T>)[]): ProcessThreadInfo[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ProcessThreadInfo>[]

      Additional items to add to the end of array1.

    Returns ProcessThreadInfo[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ProcessThreadInfo[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ProcessThreadInfo]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ProcessThreadInfo]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): boolean
        • Parameters

          • value: ProcessThreadInfo
          • index: number
          • array: ProcessThreadInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ProcessThreadInfo, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ProcessThreadInfo

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ProcessThreadInfo[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ProcessThreadInfo

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): boolean
        • Parameters

          • value: ProcessThreadInfo
          • index: number
          • array: ProcessThreadInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): any
        • Parameters

          • value: ProcessThreadInfo
          • index: number
          • array: ProcessThreadInfo[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ProcessThreadInfo[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ProcessThreadInfo | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ProcessThreadInfo

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ProcessThreadInfo, index: number, obj: ProcessThreadInfo[]): boolean
        • Parameters

          • this: void
          • value: ProcessThreadInfo
          • index: number
          • obj: ProcessThreadInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ProcessThreadInfo, index: number, obj: ProcessThreadInfo[]): boolean
        • Parameters

          • value: ProcessThreadInfo
          • index: number
          • obj: ProcessThreadInfo[]

          Returns boolean

    • Optional thisArg: any

    Returns ProcessThreadInfo | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ProcessThreadInfo, index: number, obj: ProcessThreadInfo[]): boolean
        • Parameters

          • value: ProcessThreadInfo
          • index: number
          • obj: ProcessThreadInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): void
        • Parameters

          • value: ProcessThreadInfo
          • index: number
          • array: ProcessThreadInfo[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ProcessThreadInfo, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ProcessThreadInfo

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ProcessThreadInfo, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ProcessThreadInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ProcessThreadInfo, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ProcessThreadInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): U
        • Parameters

          • value: ProcessThreadInfo
          • index: number
          • array: ProcessThreadInfo[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ProcessThreadInfo | undefined
  • Removes the last element from an array and returns it.

    Returns ProcessThreadInfo | undefined

push

  • push(...items: ProcessThreadInfo[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ProcessThreadInfo[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ProcessThreadInfo
  • reduce(callbackfn: function, initialValue: ProcessThreadInfo): ProcessThreadInfo
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProcessThreadInfo, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): ProcessThreadInfo
        • Parameters

          • previousValue: ProcessThreadInfo
          • currentValue: ProcessThreadInfo
          • currentIndex: number
          • array: ProcessThreadInfo[]

          Returns ProcessThreadInfo

    Returns ProcessThreadInfo

  • Parameters

    • callbackfn: function
        • (previousValue: ProcessThreadInfo, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): ProcessThreadInfo
        • Parameters

          • previousValue: ProcessThreadInfo
          • currentValue: ProcessThreadInfo
          • currentIndex: number
          • array: ProcessThreadInfo[]

          Returns ProcessThreadInfo

    • initialValue: ProcessThreadInfo

    Returns ProcessThreadInfo

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: ProcessThreadInfo
          • currentIndex: number
          • array: ProcessThreadInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ProcessThreadInfo
  • reduceRight(callbackfn: function, initialValue: ProcessThreadInfo): ProcessThreadInfo
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ProcessThreadInfo, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): ProcessThreadInfo
        • Parameters

          • previousValue: ProcessThreadInfo
          • currentValue: ProcessThreadInfo
          • currentIndex: number
          • array: ProcessThreadInfo[]

          Returns ProcessThreadInfo

    Returns ProcessThreadInfo

  • Parameters

    • callbackfn: function
        • (previousValue: ProcessThreadInfo, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): ProcessThreadInfo
        • Parameters

          • previousValue: ProcessThreadInfo
          • currentValue: ProcessThreadInfo
          • currentIndex: number
          • array: ProcessThreadInfo[]

          Returns ProcessThreadInfo

    • initialValue: ProcessThreadInfo

    Returns ProcessThreadInfo

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: ProcessThreadInfo
          • currentIndex: number
          • array: ProcessThreadInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ProcessThreadInfo[]
  • Reverses the elements in an Array.

    Returns ProcessThreadInfo[]

shift

  • shift(): ProcessThreadInfo | undefined
  • Removes the first element from an array and returns it.

    Returns ProcessThreadInfo | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ProcessThreadInfo[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ProcessThreadInfo[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): boolean
        • Parameters

          • value: ProcessThreadInfo
          • index: number
          • array: ProcessThreadInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ProcessThreadInfo[]
  • splice(start: number, deleteCount: number, ...items: ProcessThreadInfo[]): ProcessThreadInfo[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ProcessThreadInfo[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ProcessThreadInfo[]

      Elements to insert into the array in place of the deleted elements.

    Returns ProcessThreadInfo[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ProcessThreadInfo[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ProcessThreadInfo[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ProcessThreadInfo>
  • Returns an iterable of values in the array

    Returns IterableIterator<ProcessThreadInfo>

type

type: object

className

className: string = "ProcessThreadInfoCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ProcessThreadInfo"

name

name: "Composite" = "Composite"

Const ProxyOnlyResource

ProxyOnlyResource: object

Azure proxy only resource. This resource is not tracked by Azure Resource Manager.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProxyOnlyResource"

type

type: object

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProxyOnlyResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

kind

kind: object

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const PublicCertificate

PublicCertificate: object

Public certificate object

Optional blob

blob: Uint8Array

Public Certificate byte array

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicCertificateLocation

publicCertificateLocation: PublicCertificateLocation

Public Certificate Location. Possible values include: 'CurrentUserMy', 'LocalMachineMy', 'Unknown'

serializedName

serializedName: string = "PublicCertificate"

Optional thumbprint

thumbprint: undefined | string

Certificate Thumbprint NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "PublicCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blob

blob: object

serializedName

serializedName: string = "properties.blob"

type

type: object

name

name: "ByteArray" = "ByteArray"

publicCertificateLocation

publicCertificateLocation: object

serializedName

serializedName: string = "properties.publicCertificateLocation"

type

type: object

allowedValues

allowedValues: string[] = ["CurrentUserMy","LocalMachineMy","Unknown"]

name

name: "Enum" = "Enum"

thumbprint

thumbprint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

name: "String" = "String"

Const PublicCertificateCollection

PublicCertificateCollection: object
interface

Collection of public certificates

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PublicCertificateCollection"

__@iterator

  • __@iterator(): IterableIterator<PublicCertificate>
  • Iterator

    Returns IterableIterator<PublicCertificate>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<PublicCertificate>[]): PublicCertificate[]
  • concat(...items: (T | ConcatArray<T>)[]): PublicCertificate[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<PublicCertificate>[]

      Additional items to add to the end of array1.

    Returns PublicCertificate[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns PublicCertificate[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, PublicCertificate]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, PublicCertificate]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: PublicCertificate, index: number, array: PublicCertificate[]): boolean
        • Parameters

          • value: PublicCertificate
          • index: number
          • array: PublicCertificate[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: PublicCertificate, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: PublicCertificate

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): PublicCertificate[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: PublicCertificate

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PublicCertificate, index: number, array: PublicCertificate[]): boolean
        • Parameters

          • value: PublicCertificate
          • index: number
          • array: PublicCertificate[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: PublicCertificate, index: number, array: PublicCertificate[]): any
        • Parameters

          • value: PublicCertificate
          • index: number
          • array: PublicCertificate[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns PublicCertificate[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): PublicCertificate | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: PublicCertificate

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: PublicCertificate, index: number, obj: PublicCertificate[]): boolean
        • Parameters

          • this: void
          • value: PublicCertificate
          • index: number
          • obj: PublicCertificate[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: PublicCertificate, index: number, obj: PublicCertificate[]): boolean
        • Parameters

          • value: PublicCertificate
          • index: number
          • obj: PublicCertificate[]

          Returns boolean

    • Optional thisArg: any

    Returns PublicCertificate | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: PublicCertificate, index: number, obj: PublicCertificate[]): boolean
        • Parameters

          • value: PublicCertificate
          • index: number
          • obj: PublicCertificate[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: PublicCertificate, index: number, array: PublicCertificate[]): void
        • Parameters

          • value: PublicCertificate
          • index: number
          • array: PublicCertificate[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: PublicCertificate, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: PublicCertificate

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: PublicCertificate, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: PublicCertificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: PublicCertificate, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: PublicCertificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: PublicCertificate, index: number, array: PublicCertificate[]): U
        • Parameters

          • value: PublicCertificate
          • index: number
          • array: PublicCertificate[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): PublicCertificate | undefined
  • Removes the last element from an array and returns it.

    Returns PublicCertificate | undefined

push

  • push(...items: PublicCertificate[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: PublicCertificate[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): PublicCertificate
  • reduce(callbackfn: function, initialValue: PublicCertificate): PublicCertificate
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: PublicCertificate, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): PublicCertificate
        • Parameters

          • previousValue: PublicCertificate
          • currentValue: PublicCertificate
          • currentIndex: number
          • array: PublicCertificate[]

          Returns PublicCertificate

    Returns PublicCertificate

  • Parameters

    • callbackfn: function
        • (previousValue: PublicCertificate, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): PublicCertificate
        • Parameters

          • previousValue: PublicCertificate
          • currentValue: PublicCertificate
          • currentIndex: number
          • array: PublicCertificate[]

          Returns PublicCertificate

    • initialValue: PublicCertificate

    Returns PublicCertificate

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): U
        • Parameters

          • previousValue: U
          • currentValue: PublicCertificate
          • currentIndex: number
          • array: PublicCertificate[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): PublicCertificate
  • reduceRight(callbackfn: function, initialValue: PublicCertificate): PublicCertificate
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: PublicCertificate, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): PublicCertificate
        • Parameters

          • previousValue: PublicCertificate
          • currentValue: PublicCertificate
          • currentIndex: number
          • array: PublicCertificate[]

          Returns PublicCertificate

    Returns PublicCertificate

  • Parameters

    • callbackfn: function
        • (previousValue: PublicCertificate, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): PublicCertificate
        • Parameters

          • previousValue: PublicCertificate
          • currentValue: PublicCertificate
          • currentIndex: number
          • array: PublicCertificate[]

          Returns PublicCertificate

    • initialValue: PublicCertificate

    Returns PublicCertificate

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): U
        • Parameters

          • previousValue: U
          • currentValue: PublicCertificate
          • currentIndex: number
          • array: PublicCertificate[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): PublicCertificate[]
  • Reverses the elements in an Array.

    Returns PublicCertificate[]

shift

  • shift(): PublicCertificate | undefined
  • Removes the first element from an array and returns it.

    Returns PublicCertificate | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): PublicCertificate[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns PublicCertificate[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: PublicCertificate, index: number, array: PublicCertificate[]): boolean
        • Parameters

          • value: PublicCertificate
          • index: number
          • array: PublicCertificate[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): PublicCertificate[]
  • splice(start: number, deleteCount: number, ...items: PublicCertificate[]): PublicCertificate[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns PublicCertificate[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: PublicCertificate[]

      Elements to insert into the array in place of the deleted elements.

    Returns PublicCertificate[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: PublicCertificate[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: PublicCertificate[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<PublicCertificate>
  • Returns an iterable of values in the array

    Returns IterableIterator<PublicCertificate>

type

type: object

className

className: string = "PublicCertificateCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "PublicCertificate"

name

name: "Composite" = "Composite"

Const PushSettings

PushSettings: object

Push settings for the App.

Optional dynamicTagsJson

dynamicTagsJson: undefined | string

Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

isPushEnabled

isPushEnabled: boolean

Gets or sets a flag indicating whether the Push endpoint is enabled.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PushSettings"

Optional tagWhitelistJson

tagWhitelistJson: undefined | string

Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.

Optional tagsRequiringAuth

tagsRequiringAuth: undefined | string

Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.

type

type: object

className

className: string = "PushSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dynamicTagsJson

dynamicTagsJson: object

serializedName

serializedName: string = "properties.dynamicTagsJson"

type

type: object

name

name: "String" = "String"

isPushEnabled

isPushEnabled: object

required

required: true = true

serializedName

serializedName: string = "properties.isPushEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

tagWhitelistJson

tagWhitelistJson: object

serializedName

serializedName: string = "properties.tagWhitelistJson"

type

type: object

name

name: "String" = "String"

tagsRequiringAuth

tagsRequiringAuth: object

serializedName

serializedName: string = "properties.tagsRequiringAuth"

type

type: object

name

name: "String" = "String"

Const RampUpRule

RampUpRule: object

Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

Optional actionHostName

actionHostName: undefined | string

Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

Optional changeDecisionCallbackUrl

changeDecisionCallbackUrl: undefined | string

Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/

Optional changeIntervalInMinutes

changeIntervalInMinutes: undefined | number

Specifies interval in minutes to reevaluate ReroutePercentage.

Optional changeStep

changeStep: undefined | number

In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.

Optional maxReroutePercentage

maxReroutePercentage: undefined | number

Specifies upper boundary below which ReroutePercentage will stay.

Optional minReroutePercentage

minReroutePercentage: undefined | number

Specifies lower boundary above which ReroutePercentage will stay.

Optional name

name: undefined | string

Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

Optional reroutePercentage

reroutePercentage: undefined | number

Percentage of the traffic which will be redirected to ActionHostName.

serializedName

serializedName: string = "RampUpRule"

type

type: object

className

className: string = "RampUpRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionHostName

actionHostName: object

serializedName

serializedName: string = "actionHostName"

type

type: object

name

name: "String" = "String"

changeDecisionCallbackUrl

changeDecisionCallbackUrl: object

serializedName

serializedName: string = "changeDecisionCallbackUrl"

type

type: object

name

name: "String" = "String"

changeIntervalInMinutes

changeIntervalInMinutes: object

serializedName

serializedName: string = "changeIntervalInMinutes"

type

type: object

name

name: "Number" = "Number"

changeStep

changeStep: object

serializedName

serializedName: string = "changeStep"

type

type: object

name

name: "Number" = "Number"

maxReroutePercentage

maxReroutePercentage: object

serializedName

serializedName: string = "maxReroutePercentage"

type

type: object

name

name: "Number" = "Number"

minReroutePercentage

minReroutePercentage: object

serializedName

serializedName: string = "minReroutePercentage"

type

type: object

name

name: "Number" = "Number"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

reroutePercentage

reroutePercentage: object

serializedName

serializedName: string = "reroutePercentage"

type

type: object

name

name: "Number" = "Number"

Const Recommendation

Recommendation: object

Represents a recommendation result generated by the recommendation engine.

Optional actionName

actionName: undefined | string

Name of action recommended by this object.

Optional bladeName

bladeName: undefined | string

Deep link to a blade on the portal.

Optional categoryTags

categoryTags: string[]

The list of category tags that this recommendation belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional channels

channels: Channels

List of channels that this recommendation can apply. Possible values include: 'Notification', 'Api', 'Email', 'Webhook', 'All'

Optional creationTime

creationTime: Date

Timestamp when this instance was created.

Optional displayName

displayName: undefined | string

UI friendly name of the rule (may not be unique).

Optional enabled

enabled: undefined | number

True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.

Optional endTime

endTime: Date

The end time in UTC of a range that the recommendation refers to.

Optional extensionName

extensionName: undefined | string

Extension name of the portal if exists.

Optional forwardLink

forwardLink: undefined | string

Forward link to an external document associated with the rule.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDynamic

isDynamic: undefined | false | true

True if this is associated with a dynamically added rule

Optional kind

kind: undefined | string

Kind of resource.

Optional level

Level indicating how critical this recommendation can impact. Possible values include: 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'

Optional message

message: undefined | string

Recommendation text.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextNotificationTime

nextNotificationTime: Date

When to notify this recommendation next in UTC. Null means that this will never be notified anymore.

Optional notificationExpirationTime

notificationExpirationTime: Date

Date and time in UTC when this notification expires.

Optional notifiedTime

notifiedTime: Date

Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.

Optional recommendationId

recommendationId: undefined | string

A GUID value that each recommendation object is associated with.

Optional resourceId

resourceId: undefined | string

Full ARM resource ID string that this recommendation object is associated with.

Optional resourceScope

resourceScope: ResourceScopeType

Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. Possible values include: 'ServerFarm', 'Subscription', 'WebSite'

Optional ruleName

ruleName: undefined | string

Unique name of the rule.

Optional score

score: undefined | number

A metric value measured by the rule.

serializedName

serializedName: string = "Recommendation"

Optional startTime

startTime: Date

The beginning time in UTC of a range that the recommendation refers to.

Optional states

states: string[]

The list of states of this recommendation. If it's null then it should be considered "Active".

type

type: object

className

className: string = "Recommendation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionName

actionName: object

serializedName

serializedName: string = "properties.actionName"

type

type: object

name

name: "String" = "String"

bladeName

bladeName: object

serializedName

serializedName: string = "properties.bladeName"

type

type: object

name

name: "String" = "String"

categoryTags

categoryTags: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.categoryTags"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

channels

channels: object

serializedName

serializedName: string = "properties.channels"

type

type: object

allowedValues

allowedValues: string[] = ["Notification","Api","Email","Webhook","All"]

name

name: "Enum" = "Enum"

creationTime

creationTime: object

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

name: "DateTime" = "DateTime"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Number" = "Number"

endTime

endTime: object

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

extensionName

extensionName: object

serializedName

serializedName: string = "properties.extensionName"

type

type: object

name

name: "String" = "String"

forwardLink

forwardLink: object

serializedName

serializedName: string = "properties.forwardLink"

type

type: object

name

name: "String" = "String"

isDynamic

isDynamic: object

serializedName

serializedName: string = "properties.isDynamic"

type

type: object

name

name: "Boolean" = "Boolean"

level

level: object

serializedName

serializedName: string = "properties.level"

type

type: object

allowedValues

allowedValues: string[] = ["Critical","Warning","Information","NonUrgentSuggestion"]

name

name: "Enum" = "Enum"

message

message: object

serializedName

serializedName: string = "properties.message"

type

type: object

name

name: "String" = "String"

nextNotificationTime

nextNotificationTime: object

serializedName

serializedName: string = "properties.nextNotificationTime"

type

type: object

name

name: "DateTime" = "DateTime"

notificationExpirationTime

notificationExpirationTime: object

serializedName

serializedName: string = "properties.notificationExpirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

notifiedTime

notifiedTime: object

serializedName

serializedName: string = "properties.notifiedTime"

type

type: object

name

name: "DateTime" = "DateTime"

recommendationId

recommendationId: object

serializedName

serializedName: string = "properties.recommendationId"

type

type: object

name

name: "Uuid" = "Uuid"

resourceId

resourceId: object

serializedName

serializedName: string = "properties.resourceId"

type

type: object

name

name: "String" = "String"

resourceScope

resourceScope: object

serializedName

serializedName: string = "properties.resourceScope"

type

type: object

name

name: "String" = "String"

ruleName

ruleName: object

serializedName

serializedName: string = "properties.ruleName"

type

type: object

name

name: "String" = "String"

score

score: object

serializedName

serializedName: string = "properties.score"

type

type: object

name

name: "Number" = "Number"

startTime

startTime: object

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

states

states: object

serializedName

serializedName: string = "properties.states"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const RecommendationCollection

RecommendationCollection: object
interface

Collection of recommendations.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RecommendationCollection"

__@iterator

  • __@iterator(): IterableIterator<Recommendation>
  • Iterator

    Returns IterableIterator<Recommendation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Recommendation>[]): Recommendation[]
  • concat(...items: (T | ConcatArray<T>)[]): Recommendation[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Recommendation>[]

      Additional items to add to the end of array1.

    Returns Recommendation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Recommendation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Recommendation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Recommendation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Recommendation, index: number, array: Recommendation[]): boolean
        • Parameters

          • value: Recommendation
          • index: number
          • array: Recommendation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Recommendation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Recommendation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Recommendation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Recommendation

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Recommendation, index: number, array: Recommendation[]): boolean
        • Parameters

          • value: Recommendation
          • index: number
          • array: Recommendation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Recommendation, index: number, array: Recommendation[]): any
        • Parameters

          • value: Recommendation
          • index: number
          • array: Recommendation[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Recommendation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Recommendation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Recommendation

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Recommendation, index: number, obj: Recommendation[]): boolean
        • Parameters

          • this: void
          • value: Recommendation
          • index: number
          • obj: Recommendation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Recommendation, index: number, obj: Recommendation[]): boolean
        • Parameters

          • value: Recommendation
          • index: number
          • obj: Recommendation[]

          Returns boolean

    • Optional thisArg: any

    Returns Recommendation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Recommendation, index: number, obj: Recommendation[]): boolean
        • Parameters

          • value: Recommendation
          • index: number
          • obj: Recommendation[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Recommendation, index: number, array: Recommendation[]): void
        • Parameters

          • value: Recommendation
          • index: number
          • array: Recommendation[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Recommendation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Recommendation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Recommendation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Recommendation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Recommendation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Recommendation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Recommendation, index: number, array: Recommendation[]): U
        • Parameters

          • value: Recommendation
          • index: number
          • array: Recommendation[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Recommendation | undefined
  • Removes the last element from an array and returns it.

    Returns Recommendation | undefined

push

  • push(...items: Recommendation[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Recommendation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Recommendation
  • reduce(callbackfn: function, initialValue: Recommendation): Recommendation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Recommendation, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): Recommendation
        • Parameters

          • previousValue: Recommendation
          • currentValue: Recommendation
          • currentIndex: number
          • array: Recommendation[]

          Returns Recommendation

    Returns Recommendation

  • Parameters

    • callbackfn: function
        • (previousValue: Recommendation, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): Recommendation
        • Parameters

          • previousValue: Recommendation
          • currentValue: Recommendation
          • currentIndex: number
          • array: Recommendation[]

          Returns Recommendation

    • initialValue: Recommendation

    Returns Recommendation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): U
        • Parameters

          • previousValue: U
          • currentValue: Recommendation
          • currentIndex: number
          • array: Recommendation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Recommendation
  • reduceRight(callbackfn: function, initialValue: Recommendation): Recommendation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Recommendation, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): Recommendation
        • Parameters

          • previousValue: Recommendation
          • currentValue: Recommendation
          • currentIndex: number
          • array: Recommendation[]

          Returns Recommendation

    Returns Recommendation

  • Parameters

    • callbackfn: function
        • (previousValue: Recommendation, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): Recommendation
        • Parameters

          • previousValue: Recommendation
          • currentValue: Recommendation
          • currentIndex: number
          • array: Recommendation[]

          Returns Recommendation

    • initialValue: Recommendation

    Returns Recommendation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): U
        • Parameters

          • previousValue: U
          • currentValue: Recommendation
          • currentIndex: number
          • array: Recommendation[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Recommendation[]
  • Reverses the elements in an Array.

    Returns Recommendation[]

shift

  • shift(): Recommendation | undefined
  • Removes the first element from an array and returns it.

    Returns Recommendation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Recommendation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Recommendation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Recommendation, index: number, array: Recommendation[]): boolean
        • Parameters

          • value: Recommendation
          • index: number
          • array: Recommendation[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Recommendation[]
  • splice(start: number, deleteCount: number, ...items: Recommendation[]): Recommendation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Recommendation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Recommendation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Recommendation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Recommendation[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Recommendation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Recommendation>
  • Returns an iterable of values in the array

    Returns IterableIterator<Recommendation>

type

type: object

className

className: string = "RecommendationCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Recommendation"

name

name: "Composite" = "Composite"

Const RecommendationRule

RecommendationRule: object

Represents a recommendation rule that the recommendation engine can perform.

Optional actionName

actionName: undefined | string

Name of action that is recommended by this rule in string.

Optional bladeName

bladeName: undefined | string

Deep link to a blade on the portal. Applicable to dynamic rule only.

Optional categoryTags

categoryTags: string[]

The list of category tags that this recommendation rule belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional channels

channels: Channels

List of available channels that this rule applies. Possible values include: 'Notification', 'Api', 'Email', 'Webhook', 'All'

Optional description

description: undefined | string

Localized detailed description of the rule.

Optional displayName

displayName: undefined | string

UI friendly name of the rule.

Optional extensionName

extensionName: undefined | string

Extension name of the portal if exists. Applicable to dynamic rule only.

Optional forwardLink

forwardLink: undefined | string

Forward link to an external document associated with the rule. Applicable to dynamic rule only.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDynamic

isDynamic: undefined | false | true

True if this is associated with a dynamically added rule

Optional kind

kind: undefined | string

Kind of resource.

Optional level

Level of impact indicating how critical this rule is. Possible values include: 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'

Optional message

message: undefined | string

Localized name of the rule (Good for UI).

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recommendationId

recommendationId: undefined | string

Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null.

Optional recommendationName

recommendationName: undefined | string

Unique name of the rule.

serializedName

serializedName: string = "RecommendationRule"

type

type: object

className

className: string = "RecommendationRule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionName

actionName: object

serializedName

serializedName: string = "properties.actionName"

type

type: object

name

name: "String" = "String"

bladeName

bladeName: object

serializedName

serializedName: string = "properties.bladeName"

type

type: object

name

name: "String" = "String"

categoryTags

categoryTags: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.categoryTags"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

channels

channels: object

serializedName

serializedName: string = "properties.channels"

type

type: object

allowedValues

allowedValues: string[] = ["Notification","Api","Email","Webhook","All"]

name

name: "Enum" = "Enum"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

displayName

displayName: object

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

name: "String" = "String"

extensionName

extensionName: object

serializedName

serializedName: string = "properties.extensionName"

type

type: object

name

name: "String" = "String"

forwardLink

forwardLink: object

serializedName

serializedName: string = "properties.forwardLink"

type

type: object

name

name: "String" = "String"

isDynamic

isDynamic: object

serializedName

serializedName: string = "properties.isDynamic"

type

type: object

name

name: "Boolean" = "Boolean"

level

level: object

serializedName

serializedName: string = "properties.level"

type

type: object

allowedValues

allowedValues: string[] = ["Critical","Warning","Information","NonUrgentSuggestion"]

name

name: "Enum" = "Enum"

message

message: object

serializedName

serializedName: string = "properties.message"

type

type: object

name

name: "String" = "String"

recommendationId

recommendationId: object

serializedName

serializedName: string = "properties.recommendationId"

type

type: object

name

name: "Uuid" = "Uuid"

recommendationName

recommendationName: object

serializedName

serializedName: string = "properties.recommendationName"

type

type: object

name

name: "String" = "String"

Const RelayServiceConnectionEntity

RelayServiceConnectionEntity: object

Hybrid Connection for an App Service app.

Optional biztalkUri

biztalkUri: undefined | string

Optional entityConnectionString

entityConnectionString: undefined | string

Optional entityName

entityName: undefined | string

Optional hostname

hostname: undefined | string

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional port

port: undefined | number

Optional resourceConnectionString

resourceConnectionString: undefined | string

Optional resourceType

resourceType: undefined | string

serializedName

serializedName: string = "RelayServiceConnectionEntity"

type

type: object

className

className: string = "RelayServiceConnectionEntity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

biztalkUri

biztalkUri: object

serializedName

serializedName: string = "properties.biztalkUri"

type

type: object

name

name: "String" = "String"

entityConnectionString

entityConnectionString: object

serializedName

serializedName: string = "properties.entityConnectionString"

type

type: object

name

name: "String" = "String"

entityName

entityName: object

serializedName

serializedName: string = "properties.entityName"

type

type: object

name

name: "String" = "String"

hostname

hostname: object

serializedName

serializedName: string = "properties.hostname"

type

type: object

name

name: "String" = "String"

port

port: object

serializedName

serializedName: string = "properties.port"

type

type: object

name

name: "Number" = "Number"

resourceConnectionString

resourceConnectionString: object

serializedName

serializedName: string = "properties.resourceConnectionString"

type

type: object

name

name: "String" = "String"

resourceType

resourceType: object

serializedName

serializedName: string = "properties.resourceType"

type

type: object

name

name: "String" = "String"

Const RequestsBasedTrigger

RequestsBasedTrigger: object

Trigger based on total requests.

Optional count

count: undefined | number

Request Count.

serializedName

serializedName: string = "RequestsBasedTrigger"

Optional timeInterval

timeInterval: undefined | string

Time interval.

type

type: object

className

className: string = "RequestsBasedTrigger"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

timeInterval

timeInterval: object

serializedName

serializedName: string = "timeInterval"

type

type: object

name

name: "String" = "String"

Const Resource

Resource: object

Azure resource. This resource is tracked in Azure Resource Manager

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

location

location: string

Resource Location.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional tags

tags: undefined | object

Resource tags.

type

type: object

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

kind

kind: object

serializedName

serializedName: string = "kind"

type

type: object

name

name: "String" = "String"

location

location: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceCollection

ResourceCollection: object
interface

Collection of resources.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceCollection"

__@iterator

  • __@iterator(): IterableIterator<string>
  • Iterator

    Returns IterableIterator<string>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<string>[]): string[]
  • concat(...items: (T | ConcatArray<T>)[]): string[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<string>[]

      Additional items to add to the end of array1.

    Returns string[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns string[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, string]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, string]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: string, index: number, array: string[]): boolean
        • Parameters

          • value: string
          • index: number
          • array: string[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: string, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: string

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): string[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: string

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: string, index: number, array: string[]): boolean
        • Parameters

          • value: string
          • index: number
          • array: string[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: string, index: number, array: string[]): any
        • Parameters

          • value: string
          • index: number
          • array: string[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns string[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): string | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: string

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: string, index: number, obj: string[]): boolean
        • Parameters

          • this: void
          • value: string
          • index: number
          • obj: string[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: string, index: number, obj: string[]): boolean
        • Parameters

          • value: string
          • index: number
          • obj: string[]

          Returns boolean

    • Optional thisArg: any

    Returns string | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: string, index: number, obj: string[]): boolean
        • Parameters

          • value: string
          • index: number
          • obj: string[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: string, index: number, array: string[]): void
        • Parameters

          • value: string
          • index: number
          • array: string[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: string, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: string

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: string, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: string

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: string, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: string

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: string, index: number, array: string[]): U
        • Parameters

          • value: string
          • index: number
          • array: string[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): string | undefined
  • Removes the last element from an array and returns it.

    Returns string | undefined

push

  • push(...items: string[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: string[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): string
  • reduce(callbackfn: function, initialValue: string): string
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: string, currentValue: string, currentIndex: number, array: string[]): string
        • Parameters

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: string[]

          Returns string

    Returns string

  • Parameters

    • callbackfn: function
        • (previousValue: string, currentValue: string, currentIndex: number, array: string[]): string
        • Parameters

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: string[]

          Returns string

    • initialValue: string

    Returns string

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: string, currentIndex: number, array: string[]): U
        • Parameters

          • previousValue: U
          • currentValue: string
          • currentIndex: number
          • array: string[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): string
  • reduceRight(callbackfn: function, initialValue: string): string
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: string, currentValue: string, currentIndex: number, array: string[]): string
        • Parameters

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: string[]

          Returns string

    Returns string

  • Parameters

    • callbackfn: function
        • (previousValue: string, currentValue: string, currentIndex: number, array: string[]): string
        • Parameters

          • previousValue: string
          • currentValue: string
          • currentIndex: number
          • array: string[]

          Returns string

    • initialValue: string

    Returns string

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: string, currentIndex: number, array: string[]): U
        • Parameters

          • previousValue: U
          • currentValue: string
          • currentIndex: number
          • array: string[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): string[]
  • Reverses the elements in an Array.

    Returns string[]

shift

  • shift(): string | undefined
  • Removes the first element from an array and returns it.

    Returns string | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): string[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns string[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: string, index: number, array: string[]): boolean
        • Parameters

          • value: string
          • index: number
          • array: string[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): string[]
  • splice(start: number, deleteCount: number, ...items: string[]): string[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns string[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: string[]

      Elements to insert into the array in place of the deleted elements.

    Returns string[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: string[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: string[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<string>
  • Returns an iterable of values in the array

    Returns IterableIterator<string>

type

type: object

className

className: string = "ResourceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const ResourceMetric

ResourceMetric: object

Object representing a metric for any resource .

Optional endTime

endTime: Date

Metric end time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional metricValues

metricValues: ResourceMetricValue[]

Metric values. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

Name of metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ResourceMetricProperty[]

Resource metric properties collection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceId

resourceId: undefined | string

Metric resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetric"

Optional startTime

startTime: Date

Metric start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timeGrain

timeGrain: undefined | string

Metric granularity. E.g PT1H, PT5M, P1D NOTE: This property will not be serialized. It can only be populated by the server.

Optional unit

unit: undefined | string

Metric unit. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetric"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

metricValues

metricValues: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "metricValues"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceMetricValue"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

className

className: string = "ResourceMetricName"

name

name: "Composite" = "Composite"

properties

properties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceMetricProperty"

name

name: "Composite" = "Composite"

resourceId

resourceId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "resourceId"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

timeGrain

timeGrain: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

Const ResourceMetricAvailability

ResourceMetricAvailability: object

Metrics availability and retention.

Optional retention

retention: undefined | string

Retention period for the current time grain. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricAvailability"

Optional timeGrain

timeGrain: undefined | string

Time grain . NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetricAvailability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

retention

retention: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "retention"

type

type: object

name

name: "String" = "String"

timeGrain

timeGrain: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "timeGrain"

type

type: object

name

name: "String" = "String"

Const ResourceMetricCollection

ResourceMetricCollection: object
interface

Collection of metric responses.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricCollection"

__@iterator

  • __@iterator(): IterableIterator<ResourceMetric>
  • Iterator

    Returns IterableIterator<ResourceMetric>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ResourceMetric>[]): ResourceMetric[]
  • concat(...items: (T | ConcatArray<T>)[]): ResourceMetric[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ResourceMetric>[]

      Additional items to add to the end of array1.

    Returns ResourceMetric[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ResourceMetric[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ResourceMetric]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ResourceMetric]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ResourceMetric, index: number, array: ResourceMetric[]): boolean
        • Parameters

          • value: ResourceMetric
          • index: number
          • array: ResourceMetric[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ResourceMetric, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ResourceMetric

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ResourceMetric[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ResourceMetric

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ResourceMetric, index: number, array: ResourceMetric[]): boolean
        • Parameters

          • value: ResourceMetric
          • index: number
          • array: ResourceMetric[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ResourceMetric, index: number, array: ResourceMetric[]): any
        • Parameters

          • value: ResourceMetric
          • index: number
          • array: ResourceMetric[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ResourceMetric[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ResourceMetric | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ResourceMetric

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ResourceMetric, index: number, obj: ResourceMetric[]): boolean
        • Parameters

          • this: void
          • value: ResourceMetric
          • index: number
          • obj: ResourceMetric[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ResourceMetric, index: number, obj: ResourceMetric[]): boolean
        • Parameters

          • value: ResourceMetric
          • index: number
          • obj: ResourceMetric[]

          Returns boolean

    • Optional thisArg: any

    Returns ResourceMetric | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ResourceMetric, index: number, obj: ResourceMetric[]): boolean
        • Parameters

          • value: ResourceMetric
          • index: number
          • obj: ResourceMetric[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ResourceMetric, index: number, array: ResourceMetric[]): void
        • Parameters

          • value: ResourceMetric
          • index: number
          • array: ResourceMetric[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ResourceMetric, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ResourceMetric

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ResourceMetric, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ResourceMetric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ResourceMetric, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ResourceMetric

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ResourceMetric, index: number, array: ResourceMetric[]): U
        • Parameters

          • value: ResourceMetric
          • index: number
          • array: ResourceMetric[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ResourceMetric | undefined
  • Removes the last element from an array and returns it.

    Returns ResourceMetric | undefined

push

  • push(...items: ResourceMetric[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ResourceMetric[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ResourceMetric
  • reduce(callbackfn: function, initialValue: ResourceMetric): ResourceMetric
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ResourceMetric, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): ResourceMetric
        • Parameters

          • previousValue: ResourceMetric
          • currentValue: ResourceMetric
          • currentIndex: number
          • array: ResourceMetric[]

          Returns ResourceMetric

    Returns ResourceMetric

  • Parameters

    • callbackfn: function
        • (previousValue: ResourceMetric, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): ResourceMetric
        • Parameters

          • previousValue: ResourceMetric
          • currentValue: ResourceMetric
          • currentIndex: number
          • array: ResourceMetric[]

          Returns ResourceMetric

    • initialValue: ResourceMetric

    Returns ResourceMetric

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): U
        • Parameters

          • previousValue: U
          • currentValue: ResourceMetric
          • currentIndex: number
          • array: ResourceMetric[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ResourceMetric
  • reduceRight(callbackfn: function, initialValue: ResourceMetric): ResourceMetric
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ResourceMetric, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): ResourceMetric
        • Parameters

          • previousValue: ResourceMetric
          • currentValue: ResourceMetric
          • currentIndex: number
          • array: ResourceMetric[]

          Returns ResourceMetric

    Returns ResourceMetric

  • Parameters

    • callbackfn: function
        • (previousValue: ResourceMetric, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): ResourceMetric
        • Parameters

          • previousValue: ResourceMetric
          • currentValue: ResourceMetric
          • currentIndex: number
          • array: ResourceMetric[]

          Returns ResourceMetric

    • initialValue: ResourceMetric

    Returns ResourceMetric

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): U
        • Parameters

          • previousValue: U
          • currentValue: ResourceMetric
          • currentIndex: number
          • array: ResourceMetric[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ResourceMetric[]
  • Reverses the elements in an Array.

    Returns ResourceMetric[]

shift

  • shift(): ResourceMetric | undefined
  • Removes the first element from an array and returns it.

    Returns ResourceMetric | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ResourceMetric[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ResourceMetric[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ResourceMetric, index: number, array: ResourceMetric[]): boolean
        • Parameters

          • value: ResourceMetric
          • index: number
          • array: ResourceMetric[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ResourceMetric[]
  • splice(start: number, deleteCount: number, ...items: ResourceMetric[]): ResourceMetric[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ResourceMetric[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ResourceMetric[]

      Elements to insert into the array in place of the deleted elements.

    Returns ResourceMetric[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ResourceMetric[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ResourceMetric[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ResourceMetric>
  • Returns an iterable of values in the array

    Returns IterableIterator<ResourceMetric>

type

type: object

className

className: string = "ResourceMetricCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceMetric"

name

name: "Composite" = "Composite"

Const ResourceMetricDefinition

ResourceMetricDefinition: object

Metadata for the metrics.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional metricAvailabilities

metricAvailabilities: ResourceMetricAvailability[]

List of time grains supported for the metric together with retention period. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional primaryAggregationType

primaryAggregationType: undefined | string

Primary aggregation type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

Resource metric definition properties. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceUri

resourceUri: undefined | string

Resource URI. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricDefinition"

Optional unit

unit: undefined | string

Unit of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetricDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

metricAvailabilities

metricAvailabilities: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.metricAvailabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceMetricAvailability"

name

name: "Composite" = "Composite"

primaryAggregationType

primaryAggregationType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.primaryAggregationType"

type

type: object

name

name: "String" = "String"

properties

properties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

resourceUri

resourceUri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceUri"

type

type: object

name

name: "String" = "String"

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.unit"

type

type: object

name

name: "String" = "String"

Const ResourceMetricDefinitionCollection

ResourceMetricDefinitionCollection: object
interface

Collection of metric definitions.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricDefinitionCollection"

__@iterator

  • __@iterator(): IterableIterator<ResourceMetricDefinition>
  • Iterator

    Returns IterableIterator<ResourceMetricDefinition>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<ResourceMetricDefinition>[]): ResourceMetricDefinition[]
  • concat(...items: (T | ConcatArray<T>)[]): ResourceMetricDefinition[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ResourceMetricDefinition>[]

      Additional items to add to the end of array1.

    Returns ResourceMetricDefinition[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ResourceMetricDefinition[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, ResourceMetricDefinition]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ResourceMetricDefinition]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): boolean
        • Parameters

          • value: ResourceMetricDefinition
          • index: number
          • array: ResourceMetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ResourceMetricDefinition, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ResourceMetricDefinition

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ResourceMetricDefinition[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: ResourceMetricDefinition

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): boolean
        • Parameters

          • value: ResourceMetricDefinition
          • index: number
          • array: ResourceMetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): any
        • Parameters

          • value: ResourceMetricDefinition
          • index: number
          • array: ResourceMetricDefinition[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ResourceMetricDefinition[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ResourceMetricDefinition | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: ResourceMetricDefinition

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: ResourceMetricDefinition, index: number, obj: ResourceMetricDefinition[]): boolean
        • Parameters

          • this: void
          • value: ResourceMetricDefinition
          • index: number
          • obj: ResourceMetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: ResourceMetricDefinition, index: number, obj: ResourceMetricDefinition[]): boolean
        • Parameters

          • value: ResourceMetricDefinition
          • index: number
          • obj: ResourceMetricDefinition[]

          Returns boolean

    • Optional thisArg: any

    Returns ResourceMetricDefinition | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: ResourceMetricDefinition, index: number, obj: ResourceMetricDefinition[]): boolean
        • Parameters

          • value: ResourceMetricDefinition
          • index: number
          • obj: ResourceMetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): void
        • Parameters

          • value: ResourceMetricDefinition
          • index: number
          • array: ResourceMetricDefinition[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ResourceMetricDefinition, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ResourceMetricDefinition

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ResourceMetricDefinition, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ResourceMetricDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ResourceMetricDefinition, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ResourceMetricDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): U
        • Parameters

          • value: ResourceMetricDefinition
          • index: number
          • array: ResourceMetricDefinition[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): ResourceMetricDefinition | undefined
  • Removes the last element from an array and returns it.

    Returns ResourceMetricDefinition | undefined

push

  • push(...items: ResourceMetricDefinition[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: ResourceMetricDefinition[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): ResourceMetricDefinition
  • reduce(callbackfn: function, initialValue: ResourceMetricDefinition): ResourceMetricDefinition
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: ResourceMetricDefinition, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): ResourceMetricDefinition
        • Parameters

          • previousValue: ResourceMetricDefinition
          • currentValue: ResourceMetricDefinition
          • currentIndex: number
          • array: ResourceMetricDefinition[]

          Returns ResourceMetricDefinition

    Returns ResourceMetricDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: ResourceMetricDefinition, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): ResourceMetricDefinition
        • Parameters

          • previousValue: ResourceMetricDefinition
          • currentValue: ResourceMetricDefinition
          • currentIndex: number
          • array: ResourceMetricDefinition[]

          Returns ResourceMetricDefinition

    • initialValue: ResourceMetricDefinition

    Returns ResourceMetricDefinition

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: ResourceMetricDefinition
          • currentIndex: number
          • array: ResourceMetricDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): ResourceMetricDefinition
  • reduceRight(callbackfn: function, initialValue: ResourceMetricDefinition): ResourceMetricDefinition
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: ResourceMetricDefinition, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): ResourceMetricDefinition
        • Parameters

          • previousValue: ResourceMetricDefinition
          • currentValue: ResourceMetricDefinition
          • currentIndex: number
          • array: ResourceMetricDefinition[]

          Returns ResourceMetricDefinition

    Returns ResourceMetricDefinition

  • Parameters

    • callbackfn: function
        • (previousValue: ResourceMetricDefinition, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): ResourceMetricDefinition
        • Parameters

          • previousValue: ResourceMetricDefinition
          • currentValue: ResourceMetricDefinition
          • currentIndex: number
          • array: ResourceMetricDefinition[]

          Returns ResourceMetricDefinition

    • initialValue: ResourceMetricDefinition

    Returns ResourceMetricDefinition

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): U
        • Parameters

          • previousValue: U
          • currentValue: ResourceMetricDefinition
          • currentIndex: number
          • array: ResourceMetricDefinition[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): ResourceMetricDefinition[]
  • Reverses the elements in an Array.

    Returns ResourceMetricDefinition[]

shift

  • shift(): ResourceMetricDefinition | undefined
  • Removes the first element from an array and returns it.

    Returns ResourceMetricDefinition | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ResourceMetricDefinition[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ResourceMetricDefinition[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): boolean
        • Parameters

          • value: ResourceMetricDefinition
          • index: number
          • array: ResourceMetricDefinition[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): ResourceMetricDefinition[]
  • splice(start: number, deleteCount: number, ...items: ResourceMetricDefinition[]): ResourceMetricDefinition[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ResourceMetricDefinition[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ResourceMetricDefinition[]

      Elements to insert into the array in place of the deleted elements.

    Returns ResourceMetricDefinition[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: ResourceMetricDefinition[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ResourceMetricDefinition[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<ResourceMetricDefinition>
  • Returns an iterable of values in the array

    Returns IterableIterator<ResourceMetricDefinition>

type

type: object

className

className: string = "ResourceMetricDefinitionCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceMetricDefinition"

name

name: "Composite" = "Composite"

Const ResourceMetricName

ResourceMetricName: object

Name of a metric for any resource .

Optional localizedValue

localizedValue: undefined | string

Localized metric name value. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricName"

Optional value

value: undefined | string

metric name value. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetricName"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localizedValue

localizedValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "localizedValue"

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ResourceMetricProperty

ResourceMetricProperty: object

Resource metric property.

Optional key

key: undefined | string

Key for resource metric property.

serializedName

serializedName: string = "ResourceMetricProperty"

Optional value

value: undefined | string

Value of pair.

type

type: object

className

className: string = "ResourceMetricProperty"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "key"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ResourceMetricValue

ResourceMetricValue: object

Value of resource metric.

Optional average

average: undefined | number

Value average. NOTE: This property will not be serialized. It can only be populated by the server.

Optional count

count: undefined | number

Value count. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maximum

maximum: undefined | number

Value maximum. NOTE: This property will not be serialized. It can only be populated by the server.

Optional minimum

minimum: undefined | number

Value minimum. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ResourceMetricProperty[]

Resource metric properties collection. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricValue"

Optional timestamp

timestamp: undefined | string

Value timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

Optional total

total: undefined | number

Value total. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetricValue"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

average

average: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "average"

type

type: object

name

name: "Number" = "Number"

count

count: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

maximum

maximum: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "maximum"

type

type: object

name

name: "Number" = "Number"

minimum

minimum: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "minimum"

type

type: object

name

name: "Number" = "Number"

properties

properties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ResourceMetricProperty"

name

name: "Composite" = "Composite"

timestamp

timestamp: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "timestamp"

type

type: object

name

name: "String" = "String"

total

total: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "total"

type

type: object

name

name: "Number" = "Number"

Const ResourceNameAvailability

ResourceNameAvailability: object

Information regarding availability of a resource name.

Optional message

message: undefined | string

If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.

Optional nameAvailable

nameAvailable: undefined | false | true

true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.

Optional reason

Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. Possible values include: 'Invalid', 'AlreadyExists'

serializedName

serializedName: string = "ResourceNameAvailability"

type

type: object

className

className: string = "ResourceNameAvailability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

nameAvailable

nameAvailable: object

serializedName

serializedName: string = "nameAvailable"

type

type: object

name

name: "Boolean" = "Boolean"

reason

reason: object

serializedName

serializedName: string = "reason"

type

type: object

name

name: "String" = "String"

Const ResourceNameAvailabilityRequest

ResourceNameAvailabilityRequest: object

Resource name availability request content.

Optional isFqdn

isFqdn: undefined | false | true

Is fully qualified domain name.

name

name: string

Resource name to verify.

serializedName

serializedName: string = "ResourceNameAvailabilityRequest"

type

type: object

Resource type used for verification. Possible values include: 'Site', 'Slot', 'HostingEnvironment', 'PublishingUser', 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots', 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'

className

className: string = "ResourceNameAvailabilityRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

isFqdn

isFqdn: object

serializedName

serializedName: string = "isFqdn"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const RestoreRequest

RestoreRequest: object

Description of a restore request.

Optional adjustConnectionStrings

adjustConnectionStrings: undefined | false | true

true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.

Optional appServicePlan

appServicePlan: undefined | string

Specify app service plan that will own restored site.

Optional blobName

blobName: undefined | string

Name of a blob which contains the backup.

Optional databases

databases: DatabaseBackupSetting[]

Collection of databases which should be restored. This list has to match the list of databases included in the backup.

Optional hostingEnvironment

hostingEnvironment: undefined | string

App Service Environment name, if needed (only when restoring an app to an App Service Environment).

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ignoreConflictingHostNames

ignoreConflictingHostNames: undefined | false | true

Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. Default value: false.

Optional ignoreDatabases

ignoreDatabases: undefined | false | true

Ignore the databases and only restore the site content. Default value: false.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationType

Operation type. Possible values include: 'Default', 'Clone', 'Relocation', 'Snapshot', 'CloudFS'. Default value: 'Default'.

overwrite

overwrite: boolean

true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.

serializedName

serializedName: string = "RestoreRequest"

Optional siteName

siteName: undefined | string

Name of an app.

storageAccountUrl

storageAccountUrl: string

SAS URL to the container.

type

type: object

className

className: string = "RestoreRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

adjustConnectionStrings

adjustConnectionStrings: object

serializedName

serializedName: string = "properties.adjustConnectionStrings"

type

type: object

name

name: "Boolean" = "Boolean"

appServicePlan

appServicePlan: object

serializedName

serializedName: string = "properties.appServicePlan"

type

type: object

name

name: "String" = "String"

blobName

blobName: object

serializedName

serializedName: string = "properties.blobName"

type

type: object

name

name: "String" = "String"

databases

databases: object

serializedName

serializedName: string = "properties.databases"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "DatabaseBackupSetting"

name

name: "Composite" = "Composite"

hostingEnvironment

hostingEnvironment: object

serializedName

serializedName: string = "properties.hostingEnvironment"

type

type: object

name

name: "String" = "String"

ignoreConflictingHostNames

ignoreConflictingHostNames: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.ignoreConflictingHostNames"

type

type: object

name

name: "Boolean" = "Boolean"

ignoreDatabases

ignoreDatabases: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.ignoreDatabases"

type

type: object

name

name: "Boolean" = "Boolean"

operationType

operationType: object

defaultValue

defaultValue: string = "Default"

serializedName

serializedName: string = "properties.operationType"

type

type: object

allowedValues

allowedValues: string[] = ["Default","Clone","Relocation","Snapshot","CloudFS"]

name

name: "Enum" = "Enum"

overwrite

overwrite: object

required

required: true = true

serializedName

serializedName: string = "properties.overwrite"

type

type: object

name

name: "Boolean" = "Boolean"

siteName

siteName: object

serializedName

serializedName: string = "properties.siteName"

type

type: object

name

name: "String" = "String"

storageAccountUrl

storageAccountUrl: object

required

required: true = true

serializedName

serializedName: string = "properties.storageAccountUrl"

type

type: object

name

name: "String" = "String"

Const ServiceSpecification

ServiceSpecification: object

Resource metrics service provided by Microsoft.Insights resource provider.

Optional logSpecifications

logSpecifications: LogSpecification[]

Optional metricSpecifications

metricSpecifications: MetricSpecification[]

serializedName

serializedName: string = "ServiceSpecification"

type

type: object

className

className: string = "ServiceSpecification"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

logSpecifications

logSpecifications: object

serializedName

serializedName: string = "logSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "LogSpecification"

name

name: "Composite" = "Composite"

metricSpecifications

metricSpecifications: object

serializedName

serializedName: string = "metricSpecifications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "MetricSpecification"

name

name: "Composite" = "Composite"

Const Site

Site: object

A web app, a mobile app backend, or an API app.

Optional availabilityState

availabilityState: SiteAvailabilityState

Management information availability state for the app. Possible values include: 'Normal', 'Limited', 'DisasterRecoveryMode' NOTE: This property will not be serialized. It can only be populated by the server.

Optional clientAffinityEnabled

clientAffinityEnabled: undefined | false | true

true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

Optional clientCertEnabled

clientCertEnabled: undefined | false | true

true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

Optional clientCertExclusionPaths

clientCertExclusionPaths: undefined | string

client certificate authentication comma-separated exclusion paths

Optional cloningInfo

cloningInfo: CloningInfo

If specified during app creation, the app is cloned from a source app.

Optional containerSize

containerSize: undefined | number

Size of the function container.

Optional dailyMemoryTimeQuota

dailyMemoryTimeQuota: undefined | number

Maximum allowed daily memory-time quota (applicable on dynamic apps only).

Optional defaultHostName

defaultHostName: undefined | string

Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enabled

enabled: undefined | false | true

true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

Optional enabledHostNames

enabledHostNames: string[]

Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. NOTE: This property will not be serialized. It can only be populated by the server.

Optional geoDistributions

geoDistributions: GeoDistribution[]

GeoDistributions for this site

Optional hostNameSslStates

hostNameSslStates: HostNameSslState[]

Hostname SSL states are used to manage the SSL bindings for app's hostnames.

Optional hostNames

hostNames: string[]

Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNamesDisabled

hostNamesDisabled: undefined | false | true

true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

App Service Environment to use for the app.

Optional httpsOnly

httpsOnly: undefined | false | true

HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

Optional hyperV

hyperV: undefined | false | true

Hyper-V sandbox. Default value: false.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

Optional inProgressOperationId

inProgressOperationId: undefined | string

Specifies an operation id if this site has a pending operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDefaultContainer

isDefaultContainer: undefined | false | true

true if the app is a default container; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isXenon

isXenon: undefined | false | true

Obsolete: Hyper-V sandbox. Default value: false.

Optional kind

kind: undefined | string

Kind of resource.

Optional lastModifiedTimeUtc

lastModifiedTimeUtc: Date

Last time the app was modified, in UTC. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

Resource Location.

Optional maxNumberOfWorkers

maxNumberOfWorkers: undefined | number

Maximum number of workers. This only applies to Functions container. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outboundIpAddresses

outboundIpAddresses: undefined | string

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional possibleOutboundIpAddresses

possibleOutboundIpAddresses: undefined | string

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional redundancyMode

redundancyMode: RedundancyMode

Site redundancy mode. Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive', 'GeoRedundant'

Optional repositorySiteName

repositorySiteName: undefined | string

Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reserved

reserved: undefined | false | true

true if reserved; otherwise, false. Default value: false.

Optional resourceGroup

resourceGroup: undefined | string

Name of the resource group the app belongs to. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scmSiteAlsoStopped

scmSiteAlsoStopped: undefined | false | true

true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. Default value: false.

serializedName

serializedName: string = "Site"

Optional serverFarmId

serverFarmId: undefined | string

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Optional siteConfig

siteConfig: SiteConfig

Configuration of the app.

Optional slotSwapStatus

slotSwapStatus: SlotSwapStatus

Status of the last deployment slot swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: undefined | string

Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server.

Optional suspendedTill

suspendedTill: Date

App suspended till in case memory-time quota is exceeded. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

Resource tags.

Optional targetSwapSlot

targetSwapSlot: undefined | string

Specifies which deployment slot this app will swap into. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trafficManagerHostNames

trafficManagerHostNames: string[]

Azure Traffic Manager hostnames associated with the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usageState

usageState: UsageState

State indicating whether the app has exceeded its quota usage. Read-only. Possible values include: 'Normal', 'Exceeded' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Site"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

availabilityState

availabilityState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.availabilityState"

type

type: object

allowedValues

allowedValues: string[] = ["Normal","Limited","DisasterRecoveryMode"]

name

name: "Enum" = "Enum"

clientAffinityEnabled

clientAffinityEnabled: object

serializedName

serializedName: string = "properties.clientAffinityEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

clientCertEnabled

clientCertEnabled: object

serializedName

serializedName: string = "properties.clientCertEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

clientCertExclusionPaths

clientCertExclusionPaths: object

serializedName

serializedName: string = "properties.clientCertExclusionPaths"

type

type: object

name

name: "String" = "String"

cloningInfo

cloningInfo: object

serializedName

serializedName: string = "properties.cloningInfo"

type

type: object

className

className: string = "CloningInfo"

name

name: "Composite" = "Composite"

containerSize

containerSize: object

serializedName

serializedName: string = "properties.containerSize"

type

type: object

name

name: "Number" = "Number"

dailyMemoryTimeQuota

dailyMemoryTimeQuota: object

serializedName

serializedName: string = "properties.dailyMemoryTimeQuota"

type

type: object

name

name: "Number" = "Number"

defaultHostName

defaultHostName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultHostName"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

enabledHostNames

enabledHostNames: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.enabledHostNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

geoDistributions

geoDistributions: object

serializedName

serializedName: string = "properties.geoDistributions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GeoDistribution"

name

name: "Composite" = "Composite"

hostNameSslStates

hostNameSslStates: object

serializedName

serializedName: string = "properties.hostNameSslStates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HostNameSslState"

name

name: "Composite" = "Composite"

hostNames

hostNames: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hostNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

hostNamesDisabled

hostNamesDisabled: object

serializedName

serializedName: string = "properties.hostNamesDisabled"

type

type: object

name

name: "Boolean" = "Boolean"

hostingEnvironmentProfile

hostingEnvironmentProfile: object

serializedName

serializedName: string = "properties.hostingEnvironmentProfile"

type

type: object

className

className: string = "HostingEnvironmentProfile"

name

name: "Composite" = "Composite"

httpsOnly

httpsOnly: object

serializedName

serializedName: string = "properties.httpsOnly"

type

type: object

name

name: "Boolean" = "Boolean"

hyperV

hyperV: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.hyperV"

type

type: object

name

name: "Boolean" = "Boolean"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "ManagedServiceIdentity"

name

name: "Composite" = "Composite"

inProgressOperationId

inProgressOperationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inProgressOperationId"

type

type: object

name

name: "Uuid" = "Uuid"

isDefaultContainer

isDefaultContainer: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isDefaultContainer"

type

type: object

name

name: "Boolean" = "Boolean"

isXenon

isXenon: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.isXenon"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTimeUtc

lastModifiedTimeUtc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

maxNumberOfWorkers

maxNumberOfWorkers: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maxNumberOfWorkers"

type

type: object

name

name: "Number" = "Number"

outboundIpAddresses

outboundIpAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outboundIpAddresses"

type

type: object

name

name: "String" = "String"

possibleOutboundIpAddresses

possibleOutboundIpAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.possibleOutboundIpAddresses"

type

type: object

name

name: "String" = "String"

redundancyMode

redundancyMode: object

serializedName

serializedName: string = "properties.redundancyMode"

type

type: object

allowedValues

allowedValues: string[] = ["None","Manual","Failover","ActiveActive","GeoRedundant"]

name

name: "Enum" = "Enum"

repositorySiteName

repositorySiteName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.repositorySiteName"

type

type: object

name

name: "String" = "String"

reserved

reserved: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.reserved"

type

type: object

name

name: "Boolean" = "Boolean"

resourceGroup

resourceGroup: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGroup"

type

type: object

name

name: "String" = "String"

scmSiteAlsoStopped

scmSiteAlsoStopped: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.scmSiteAlsoStopped"

type

type: object

name

name: "Boolean" = "Boolean"

serverFarmId

serverFarmId: object

serializedName

serializedName: string = "properties.serverFarmId"

type

type: object

name

name: "String" = "String"

siteConfig

siteConfig: object

serializedName

serializedName: string = "properties.siteConfig"

type

type: object

className

className: string = "SiteConfig"

name

name: "Composite" = "Composite"

slotSwapStatus

slotSwapStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.slotSwapStatus"

type

type: object

className

className: string = "SlotSwapStatus"

name

name: "Composite" = "Composite"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

suspendedTill

suspendedTill: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.suspendedTill"

type

type: object

name

name: "DateTime" = "DateTime"

targetSwapSlot

targetSwapSlot: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.targetSwapSlot"

type

type: object

name

name: "String" = "String"

trafficManagerHostNames

trafficManagerHostNames: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.trafficManagerHostNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

usageState

usageState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.usageState"

type

type: object

allowedValues

allowedValues: string[] = ["Normal","Exceeded"]

name

name: "Enum" = "Enum"

Const SiteAuthSettings

SiteAuthSettings: object

Configuration settings for the Azure App Service Authentication / Authorization feature.

Optional additionalLoginParams

additionalLoginParams: string[]

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

Optional allowedAudiences

allowedAudiences: string[]

Allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.

Optional allowedExternalRedirectUrls

allowedExternalRedirectUrls: string[]

External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.

Optional clientId

clientId: undefined | string

The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

Optional clientSecret

clientSecret: undefined | string

The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

Optional clientSecretCertificateThumbprint

clientSecretCertificateThumbprint: undefined | string

An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as a replacement for the Client Secret. It is also optional.

Optional defaultProvider

The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". Possible values include: 'AzureActiveDirectory', 'Facebook', 'Google', 'MicrosoftAccount', 'Twitter'

Optional enabled

enabled: undefined | false | true

true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.

Optional facebookAppId

facebookAppId: undefined | string

The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login

Optional facebookAppSecret

facebookAppSecret: undefined | string

The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login

Optional facebookOAuthScopes

facebookOAuthScopes: string[]

The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login

Optional googleClientId

googleClientId: undefined | string

The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/

Optional googleClientSecret

googleClientSecret: undefined | string

The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/

Optional googleOAuthScopes

googleOAuthScopes: string[]

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issuer

issuer: undefined | string

The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html

Optional kind

kind: undefined | string

Kind of resource.

Optional microsoftAccountClientId

microsoftAccountClientId: undefined | string

The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm

Optional microsoftAccountClientSecret

microsoftAccountClientSecret: undefined | string

The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm

Optional microsoftAccountOAuthScopes

microsoftAccountOAuthScopes: string[]

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runtimeVersion

runtimeVersion: undefined | string

The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.

serializedName

serializedName: string = "SiteAuthSettings"

Optional tokenRefreshExtensionHours

tokenRefreshExtensionHours: undefined | number

The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.

Optional tokenStoreEnabled

tokenStoreEnabled: undefined | false | true

true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.

Optional twitterConsumerKey

twitterConsumerKey: undefined | string

The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in

Optional twitterConsumerSecret

twitterConsumerSecret: undefined | string

The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in

Optional unauthenticatedClientAction

unauthenticatedClientAction: UnauthenticatedClientAction

The action to take when an unauthenticated client attempts to access the app. Possible values include: 'RedirectToLoginPage', 'AllowAnonymous'

Optional validateIssuer

validateIssuer: undefined | false | true

Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.

type

type: object

className

className: string = "SiteAuthSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

additionalLoginParams

additionalLoginParams: object

serializedName

serializedName: string = "properties.additionalLoginParams"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

allowedAudiences

allowedAudiences: object

serializedName

serializedName: string = "properties.allowedAudiences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

allowedExternalRedirectUrls

allowedExternalRedirectUrls: object

serializedName

serializedName: string = "properties.allowedExternalRedirectUrls"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

clientId

clientId: object

serializedName

serializedName: string = "properties.clientId"

type

type: object

name

name: "String" = "String"

clientSecret

clientSecret: object

serializedName

serializedName: string = "properties.clientSecret"

type

type: object

name

name: "String" = "String"

clientSecretCertificateThumbprint

clientSecretCertificateThumbprint: object

serializedName

serializedName: string = "properties.clientSecretCertificateThumbprint"

type

type: object

name

name: "String" = "String"

defaultProvider

defaultProvider: object

serializedName

serializedName: string = "properties.defaultProvider"

type

type: object

allowedValues

allowedValues: string[] = ["AzureActiveDirectory","Facebook","Google","MicrosoftAccount","Twitter"]

name

name: "Enum" = "Enum"

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

facebookAppId

facebookAppId: object

serializedName

serializedName: string = "properties.facebookAppId"

type

type: object

name

name: "String" = "String"

facebookAppSecret

facebookAppSecret: object

serializedName

serializedName: string = "properties.facebookAppSecret"

type

type: object

name

name: "String" = "String"

facebookOAuthScopes

facebookOAuthScopes: object

serializedName

serializedName: string = "properties.facebookOAuthScopes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

googleClientId

googleClientId: object

serializedName

serializedName: string = "properties.googleClientId"

type

type: object

name

name: "String" = "String"

googleClientSecret

googleClientSecret: object

serializedName

serializedName: string = "properties.googleClientSecret"

type

type: object

name

name: "String" = "String"

googleOAuthScopes

googleOAuthScopes: object

serializedName

serializedName: string = "properties.googleOAuthScopes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

issuer

issuer: object

serializedName

serializedName: string = "properties.issuer"

type

type: object

name

name: "String" = "String"

microsoftAccountClientId

microsoftAccountClientId: object

serializedName

serializedName: string = "properties.microsoftAccountClientId"

type

type: object

name

name: "String" = "String"

microsoftAccountClientSecret

microsoftAccountClientSecret: object

serializedName

serializedName: string = "properties.microsoftAccountClientSecret"

type

type: object

name

name: "String" = "String"

microsoftAccountOAuthScopes

microsoftAccountOAuthScopes: object

serializedName

serializedName: string = "properties.microsoftAccountOAuthScopes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

runtimeVersion

runtimeVersion: object

serializedName

serializedName: string = "properties.runtimeVersion"

type

type: object

name

name: "String" = "String"

tokenRefreshExtensionHours

tokenRefreshExtensionHours: object

serializedName

serializedName: string = "properties.tokenRefreshExtensionHours"

type

type: object

name

name: "Number" = "Number"

tokenStoreEnabled

tokenStoreEnabled: object

serializedName

serializedName: string = "properties.tokenStoreEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

twitterConsumerKey

twitterConsumerKey: object

serializedName

serializedName: string = "properties.twitterConsumerKey"

type

type: object

name

name: "String" = "String"

twitterConsumerSecret

twitterConsumerSecret: object

serializedName

serializedName: string = "properties.twitterConsumerSecret"

type

type: object

name

name: "String" = "String"

unauthenticatedClientAction

unauthenticatedClientAction: object

serializedName

serializedName: string = "properties.unauthenticatedClientAction"

type

type: object

allowedValues

allowedValues: string[] = ["RedirectToLoginPage","AllowAnonymous"]

name

name: "Enum" = "Enum"

validateIssuer

validateIssuer: object

serializedName

serializedName: string = "properties.validateIssuer"

type

type: object

name

name: "Boolean" = "Boolean"

Const SiteCloneability

SiteCloneability: object

Represents whether or not an app is cloneable.

Optional blockingCharacteristics

blockingCharacteristics: SiteCloneabilityCriterion[]

List of blocking application characteristics.

Optional blockingFeatures

blockingFeatures: SiteCloneabilityCriterion[]

List of features enabled on app that prevent cloning.

Optional result

Name of app. Possible values include: 'Cloneable', 'PartiallyCloneable', 'NotCloneable'

serializedName

serializedName: string = "SiteCloneability"

Optional unsupportedFeatures

unsupportedFeatures: SiteCloneabilityCriterion[]

List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned but the features in this list will not be set up on cloned app.

type

type: object

className

className: string = "SiteCloneability"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

blockingCharacteristics

blockingCharacteristics: object

serializedName

serializedName: string = "blockingCharacteristics"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SiteCloneabilityCriterion"

name

name: "Composite" = "Composite"

blockingFeatures

blockingFeatures: object

serializedName

serializedName: string = "blockingFeatures"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SiteCloneabilityCriterion"

name

name: "Composite" = "Composite"

result

result: object

serializedName

serializedName: string = "result"

type

type: object

allowedValues

allowedValues: string[] = ["Cloneable","PartiallyCloneable","NotCloneable"]

name

name: "Enum" = "Enum"

unsupportedFeatures

unsupportedFeatures: object

serializedName

serializedName: string = "unsupportedFeatures"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SiteCloneabilityCriterion"

name

name: "Composite" = "Composite"

Const SiteCloneabilityCriterion

SiteCloneabilityCriterion: object

An app cloneability criterion.

Optional description

description: undefined | string

Description of criterion.

Optional name

name: undefined | string

Name of criterion.

serializedName

serializedName: string = "SiteCloneabilityCriterion"

type

type: object

className

className: string = "SiteCloneabilityCriterion"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const SiteConfig

SiteConfig: object

Configuration of an App Service app.

Optional alwaysOn

alwaysOn: undefined | false | true

true if Always On is enabled; otherwise, false.

Optional apiDefinition

apiDefinition: ApiDefinitionInfo

Information about the formal API definition for the app.

Optional appCommandLine

appCommandLine: undefined | string

App command line to launch.

Optional appSettings

appSettings: NameValuePair[]

Application settings.

Optional autoHealEnabled

autoHealEnabled: undefined | false | true

true if Auto Heal is enabled; otherwise, false.

Optional autoHealRules

autoHealRules: AutoHealRules

Auto Heal rules.

Optional autoSwapSlotName

autoSwapSlotName: undefined | string

Auto-swap slot name.

Optional azureStorageAccounts

azureStorageAccounts: undefined | object

User-provided Azure storage accounts.

Optional connectionStrings

connectionStrings: ConnStringInfo[]

Connection strings.

Optional cors

Cross-Origin Resource Sharing (CORS) settings.

Optional defaultDocuments

defaultDocuments: string[]

Default documents.

Optional detailedErrorLoggingEnabled

detailedErrorLoggingEnabled: undefined | false | true

true if detailed error logging is enabled; otherwise, false.

Optional documentRoot

documentRoot: undefined | string

Document root.

Optional experiments

experiments: Experiments

This is work around for polymorphic types.

Optional ftpsState

ftpsState: FtpsState

State of FTP / FTPS service. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'

Optional handlerMappings

handlerMappings: HandlerMapping[]

Handler mappings.

Optional http20Enabled

http20Enabled: undefined | false | true

Http20Enabled: configures a web site to allow clients to connect over http2.0. Default value: true.

Optional httpLoggingEnabled

httpLoggingEnabled: undefined | false | true

true if HTTP logging is enabled; otherwise, false.

Optional ipSecurityRestrictions

ipSecurityRestrictions: IpSecurityRestriction[]

IP security restrictions for main.

Optional javaContainer

javaContainer: undefined | string

Java container.

Optional javaContainerVersion

javaContainerVersion: undefined | string

Java container version.

Optional javaVersion

javaVersion: undefined | string

Java version.

Optional limits

limits: SiteLimits

Site limits.

Optional linuxFxVersion

linuxFxVersion: undefined | string

Linux App Framework and version

Optional loadBalancing

loadBalancing: SiteLoadBalancing

Site load balancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'

Optional localMySqlEnabled

localMySqlEnabled: undefined | false | true

true to enable local MySQL; otherwise, false. Default value: false.

Optional logsDirectorySizeLimit

logsDirectorySizeLimit: undefined | number

HTTP logs directory size limit.

Optional machineKey

machineKey: SiteMachineKey

Site MachineKey. NOTE: This property will not be serialized. It can only be populated by the server.

Optional managedPipelineMode

managedPipelineMode: ManagedPipelineMode

Managed pipeline mode. Possible values include: 'Integrated', 'Classic'

Optional managedServiceIdentityId

managedServiceIdentityId: undefined | number

Managed Service Identity Id

Optional minTlsVersion

minTlsVersion: SupportedTlsVersions

MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible values include: '1.0', '1.1', '1.2'

Optional netFrameworkVersion

netFrameworkVersion: undefined | string

.NET Framework version. Default value: 'v4.6'.

Optional nodeVersion

nodeVersion: undefined | string

Version of Node.js.

Optional numberOfWorkers

numberOfWorkers: undefined | number

Number of workers.

Optional phpVersion

phpVersion: undefined | string

Version of PHP.

Optional publishingUsername

publishingUsername: undefined | string

Publishing user name.

Optional push

Push endpoint settings.

Optional pythonVersion

pythonVersion: undefined | string

Version of Python.

Optional remoteDebuggingEnabled

remoteDebuggingEnabled: undefined | false | true

true if remote debugging is enabled; otherwise, false.

Optional remoteDebuggingVersion

remoteDebuggingVersion: undefined | string

Remote debugging version.

Optional requestTracingEnabled

requestTracingEnabled: undefined | false | true

true if request tracing is enabled; otherwise, false.

Optional requestTracingExpirationTime

requestTracingExpirationTime: Date

Request tracing expiration time.

Optional reservedInstanceCount

reservedInstanceCount: undefined | number

Number of reserved instances. This setting only applies to the Consumption Plan

Optional scmIpSecurityRestrictions

scmIpSecurityRestrictions: IpSecurityRestriction[]

IP security restrictions for scm.

Optional scmIpSecurityRestrictionsUseMain

scmIpSecurityRestrictionsUseMain: undefined | false | true

IP security restrictions for scm to use main.

Optional scmType

scmType: ScmType

SCM type. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive', 'VSO'

serializedName

serializedName: string = "SiteConfig"

Optional tracingOptions

tracingOptions: undefined | string

Tracing options.

Optional use32BitWorkerProcess

use32BitWorkerProcess: undefined | false | true

true to use 32-bit worker process; otherwise, false.

Optional virtualApplications

virtualApplications: VirtualApplication[]

Virtual applications.

Optional vnetName

vnetName: undefined | string

Virtual Network name.

Optional webSocketsEnabled

webSocketsEnabled: undefined | false | true

true if WebSocket is enabled; otherwise, false.

Optional windowsFxVersion

windowsFxVersion: undefined | string

Xenon App Framework and version

Optional xManagedServiceIdentityId

xManagedServiceIdentityId: undefined | number

Explicit Managed Service Identity Id

type

type: object

className

className: string = "SiteConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

alwaysOn

alwaysOn: object

serializedName

serializedName: string = "alwaysOn"

type

type: object

name

name: "Boolean" = "Boolean"

apiDefinition

apiDefinition: object

serializedName

serializedName: string = "apiDefinition"

type

type: object

className

className: string = "ApiDefinitionInfo"

name

name: "Composite" = "Composite"

appCommandLine

appCommandLine: object

serializedName

serializedName: string = "appCommandLine"

type

type: object

name

name: "String" = "String"

appSettings

appSettings: object

serializedName

serializedName: string = "appSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

autoHealEnabled

autoHealEnabled: object

serializedName

serializedName: string = "autoHealEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

autoHealRules

autoHealRules: object

serializedName

serializedName: string = "autoHealRules"

type

type: object

className

className: string = "AutoHealRules"

name

name: "Composite" = "Composite"

autoSwapSlotName

autoSwapSlotName: object

serializedName

serializedName: string = "autoSwapSlotName"

type

type: object

name

name: "String" = "String"

azureStorageAccounts

azureStorageAccounts: object

serializedName

serializedName: string = "azureStorageAccounts"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "AzureStorageInfoValue"

name

name: "Composite" = "Composite"

connectionStrings

connectionStrings: object

serializedName

serializedName: string = "connectionStrings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnStringInfo"

name

name: "Composite" = "Composite"

cors

cors: object

serializedName

serializedName: string = "cors"

type

type: object

className

className: string = "CorsSettings"

name

name: "Composite" = "Composite"

defaultDocuments

defaultDocuments: object

serializedName

serializedName: string = "defaultDocuments"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

detailedErrorLoggingEnabled

detailedErrorLoggingEnabled: object

serializedName

serializedName: string = "detailedErrorLoggingEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

documentRoot

documentRoot: object

serializedName

serializedName: string = "documentRoot"

type

type: object

name

name: "String" = "String"

experiments

experiments: object

serializedName

serializedName: string = "experiments"

type

type: object

className

className: string = "Experiments"

name

name: "Composite" = "Composite"

ftpsState

ftpsState: object

serializedName

serializedName: string = "ftpsState"

type

type: object

name

name: "String" = "String"

handlerMappings

handlerMappings: object

serializedName

serializedName: string = "handlerMappings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HandlerMapping"

name

name: "Composite" = "Composite"

http20Enabled

http20Enabled: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "http20Enabled"

type

type: object

name

name: "Boolean" = "Boolean"

httpLoggingEnabled

httpLoggingEnabled: object

serializedName

serializedName: string = "httpLoggingEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

ipSecurityRestrictions

ipSecurityRestrictions: object

serializedName

serializedName: string = "ipSecurityRestrictions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpSecurityRestriction"

name

name: "Composite" = "Composite"

javaContainer

javaContainer: object

serializedName

serializedName: string = "javaContainer"

type

type: object

name

name: "String" = "String"

javaContainerVersion

javaContainerVersion: object

serializedName

serializedName: string = "javaContainerVersion"

type

type: object

name

name: "String" = "String"

javaVersion

javaVersion: object

serializedName

serializedName: string = "javaVersion"

type

type: object

name

name: "String" = "String"

limits

limits: object

serializedName

serializedName: string = "limits"

type

type: object

className

className: string = "SiteLimits"

name

name: "Composite" = "Composite"

linuxFxVersion

linuxFxVersion: object

serializedName

serializedName: string = "linuxFxVersion"

type

type: object

name

name: "String" = "String"

loadBalancing

loadBalancing: object

serializedName

serializedName: string = "loadBalancing"

type

type: object

allowedValues

allowedValues: string[] = ["WeightedRoundRobin","LeastRequests","LeastResponseTime","WeightedTotalTraffic","RequestHash"]

name

name: "Enum" = "Enum"

localMySqlEnabled

localMySqlEnabled: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "localMySqlEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

logsDirectorySizeLimit

logsDirectorySizeLimit: object

serializedName

serializedName: string = "logsDirectorySizeLimit"

type

type: object

name

name: "Number" = "Number"

machineKey

machineKey: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "machineKey"

type

type: object

className

className: string = "SiteMachineKey"

name

name: "Composite" = "Composite"

managedPipelineMode

managedPipelineMode: object

serializedName

serializedName: string = "managedPipelineMode"

type

type: object

allowedValues

allowedValues: string[] = ["Integrated","Classic"]

name

name: "Enum" = "Enum"

managedServiceIdentityId

managedServiceIdentityId: object

serializedName

serializedName: string = "managedServiceIdentityId"

type

type: object

name

name: "Number" = "Number"

minTlsVersion

minTlsVersion: object

serializedName

serializedName: string = "minTlsVersion"

type

type: object

name

name: "String" = "String"

netFrameworkVersion

netFrameworkVersion: object

defaultValue

defaultValue: string = "v4.6"

serializedName

serializedName: string = "netFrameworkVersion"

type

type: object

name

name: "String" = "String"

nodeVersion

nodeVersion: object

serializedName

serializedName: string = "nodeVersion"

type

type: object

name

name: "String" = "String"

numberOfWorkers

numberOfWorkers: object

serializedName

serializedName: string = "numberOfWorkers"

type

type: object

name

name: "Number" = "Number"

phpVersion

phpVersion: object

serializedName

serializedName: string = "phpVersion"

type

type: object

name

name: "String" = "String"

publishingUsername

publishingUsername: object

serializedName

serializedName: string = "publishingUsername"

type

type: object

name

name: "String" = "String"

push

push: object

serializedName

serializedName: string = "push"

type

type: object

className

className: string = "PushSettings"

name

name: "Composite" = "Composite"

pythonVersion

pythonVersion: object

serializedName

serializedName: string = "pythonVersion"

type

type: object

name

name: "String" = "String"

remoteDebuggingEnabled

remoteDebuggingEnabled: object

serializedName

serializedName: string = "remoteDebuggingEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

remoteDebuggingVersion

remoteDebuggingVersion: object

serializedName

serializedName: string = "remoteDebuggingVersion"

type

type: object

name

name: "String" = "String"

requestTracingEnabled

requestTracingEnabled: object

serializedName

serializedName: string = "requestTracingEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

requestTracingExpirationTime

requestTracingExpirationTime: object

serializedName

serializedName: string = "requestTracingExpirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

reservedInstanceCount

reservedInstanceCount: object

serializedName

serializedName: string = "reservedInstanceCount"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 10

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

scmIpSecurityRestrictions

scmIpSecurityRestrictions: object

serializedName

serializedName: string = "scmIpSecurityRestrictions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpSecurityRestriction"

name

name: "Composite" = "Composite"

scmIpSecurityRestrictionsUseMain

scmIpSecurityRestrictionsUseMain: object

serializedName

serializedName: string = "scmIpSecurityRestrictionsUseMain"

type

type: object

name

name: "Boolean" = "Boolean"

scmType

scmType: object

serializedName

serializedName: string = "scmType"

type

type: object

name

name: "String" = "String"

tracingOptions

tracingOptions: object

serializedName

serializedName: string = "tracingOptions"

type

type: object

name

name: "String" = "String"

use32BitWorkerProcess

use32BitWorkerProcess: object

serializedName

serializedName: string = "use32BitWorkerProcess"

type

type: object

name

name: "Boolean" = "Boolean"

virtualApplications

virtualApplications: object

serializedName

serializedName: string = "virtualApplications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualApplication"

name

name: "Composite" = "Composite"

vnetName

vnetName: object

serializedName

serializedName: string = "vnetName"

type

type: object

name

name: "String" = "String"

webSocketsEnabled

webSocketsEnabled: object

serializedName

serializedName: string = "webSocketsEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

windowsFxVersion

windowsFxVersion: object

serializedName

serializedName: string = "windowsFxVersion"

type

type: object

name

name: "String" = "String"

xManagedServiceIdentityId

xManagedServiceIdentityId: object

serializedName

serializedName: string = "xManagedServiceIdentityId"

type

type: object

name

name: "Number" = "Number"

Const SiteConfigResource

SiteConfigResource: object

Web app configuration ARM resource.

Optional alwaysOn

alwaysOn: undefined | false | true

true if Always On is enabled; otherwise, false.

Optional apiDefinition

apiDefinition: ApiDefinitionInfo

Information about the formal API definition for the app.

Optional appCommandLine

appCommandLine: undefined | string

App command line to launch.

Optional appSettings

appSettings: NameValuePair[]

Application settings.

Optional autoHealEnabled

autoHealEnabled: undefined | false | true

true if Auto Heal is enabled; otherwise, false.

Optional autoHealRules

autoHealRules: AutoHealRules

Auto Heal rules.

Optional autoSwapSlotName

autoSwapSlotName: undefined | string

Auto-swap slot name.

Optional azureStorageAccounts

azureStorageAccounts: undefined | object

User-provided Azure storage accounts.

Optional connectionStrings

connectionStrings: ConnStringInfo[]

Connection strings.

Optional cors

Cross-Origin Resource Sharing (CORS) settings.

Optional defaultDocuments

defaultDocuments: string[]

Default documents.

Optional detailedErrorLoggingEnabled

detailedErrorLoggingEnabled: undefined | false | true

true if detailed error logging is enabled; otherwise, false.

Optional documentRoot

documentRoot: undefined | string

Document root.

Optional experiments

experiments: Experiments

This is work around for polymorphic types.

Optional ftpsState

ftpsState: FtpsState

State of FTP / FTPS service. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'

Optional handlerMappings

handlerMappings: HandlerMapping[]

Handler mappings.

Optional http20Enabled

http20Enabled: undefined | false | true

Http20Enabled: configures a web site to allow clients to connect over http2.0. Default value: true.

Optional httpLoggingEnabled

httpLoggingEnabled: undefined | false | true

true if HTTP logging is enabled; otherwise, false.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipSecurityRestrictions

ipSecurityRestrictions: IpSecurityRestriction[]

IP security restrictions for main.

Optional javaContainer

javaContainer: undefined | string

Java container.

Optional javaContainerVersion

javaContainerVersion: undefined | string

Java container version.

Optional javaVersion

javaVersion: undefined | string

Java version.

Optional kind

kind: undefined | string

Kind of resource.

Optional limits

limits: SiteLimits

Site limits.

Optional linuxFxVersion

linuxFxVersion: undefined | string

Linux App Framework and version

Optional loadBalancing

loadBalancing: SiteLoadBalancing

Site load balancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'

Optional localMySqlEnabled

localMySqlEnabled: undefined | false | true

true to enable local MySQL; otherwise, false. Default value: false.

Optional logsDirectorySizeLimit

logsDirectorySizeLimit: undefined | number

HTTP logs directory size limit.

Optional machineKey

machineKey: SiteMachineKey

Site MachineKey. NOTE: This property will not be serialized. It can only be populated by the server.

Optional managedPipelineMode

managedPipelineMode: ManagedPipelineMode

Managed pipeline mode. Possible values include: 'Integrated', 'Classic'

Optional managedServiceIdentityId

managedServiceIdentityId: undefined | number

Managed Service Identity Id

Optional minTlsVersion

minTlsVersion: SupportedTlsVersions

MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible values include: '1.0', '1.1', '1.2'

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional netFrameworkVersion

netFrameworkVersion: undefined | string

.NET Framework version. Default value: 'v4.6'.

Optional nodeVersion

nodeVersion: undefined | string

Version of Node.js.

Optional numberOfWorkers

numberOfWorkers: undefined | number

Number of workers.

Optional phpVersion

phpVersion: undefined | string

Version of PHP.

Optional publishingUsername

publishingUsername: undefined | string

Publishing user name.

Optional push

Push endpoint settings.

Optional pythonVersion

pythonVersion: undefined | string

Version of Python.

Optional remoteDebuggingEnabled

remoteDebuggingEnabled: undefined | false | true

true if remote debugging is enabled; otherwise, false.

Optional remoteDebuggingVersion

remoteDebuggingVersion: undefined | string

Remote debugging version.

Optional requestTracingEnabled

requestTracingEnabled: undefined | false | true

true if request tracing is enabled; otherwise, false.

Optional requestTracingExpirationTime

requestTracingExpirationTime: Date

Request tracing expiration time.

Optional reservedInstanceCount

reservedInstanceCount: undefined | number

Number of reserved instances. This setting only applies to the Consumption Plan

Optional scmIpSecurityRestrictions

scmIpSecurityRestrictions: IpSecurityRestriction[]

IP security restrictions for scm.

Optional scmIpSecurityRestrictionsUseMain

scmIpSecurityRestrictionsUseMain: undefined | false | true

IP security restrictions for scm to use main.

Optional scmType

scmType: ScmType

SCM type. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive', 'VSO'

serializedName

serializedName: string = "SiteConfigResource"

Optional tracingOptions

tracingOptions: undefined | string

Tracing options.

Optional use32BitWorkerProcess

use32BitWorkerProcess: undefined | false | true

true to use 32-bit worker process; otherwise, false.

Optional virtualApplications

virtualApplications: VirtualApplication[]

Virtual applications.

Optional vnetName

vnetName: undefined | string

Virtual Network name.

Optional webSocketsEnabled

webSocketsEnabled: undefined | false | true

true if WebSocket is enabled; otherwise, false.

Optional windowsFxVersion

windowsFxVersion: undefined | string

Xenon App Framework and version

Optional xManagedServiceIdentityId

xManagedServiceIdentityId: undefined | number

Explicit Managed Service Identity Id

type

type: object

className

className: string = "SiteConfigResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

alwaysOn

alwaysOn: object

serializedName

serializedName: string = "properties.alwaysOn"

type

type: object

name

name: "Boolean" = "Boolean"

apiDefinition

apiDefinition: object

serializedName

serializedName: string = "properties.apiDefinition"

type

type: object

className

className: string = "ApiDefinitionInfo"

name

name: "Composite" = "Composite"

appCommandLine

appCommandLine: object

serializedName

serializedName: string = "properties.appCommandLine"

type

type: object

name

name: "String" = "String"

appSettings

appSettings: object

serializedName

serializedName: string = "properties.appSettings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "NameValuePair"

name

name: "Composite" = "Composite"

autoHealEnabled

autoHealEnabled: object

serializedName

serializedName: string = "properties.autoHealEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

autoHealRules

autoHealRules: object

serializedName

serializedName: string = "properties.autoHealRules"

type

type: object

className

className: string = "AutoHealRules"

name

name: "Composite" = "Composite"

autoSwapSlotName

autoSwapSlotName: object

serializedName

serializedName: string = "properties.autoSwapSlotName"

type

type: object

name

name: "String" = "String"

azureStorageAccounts

azureStorageAccounts: object

serializedName

serializedName: string = "properties.azureStorageAccounts"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "AzureStorageInfoValue"

name

name: "Composite" = "Composite"

connectionStrings

connectionStrings: object

serializedName

serializedName: string = "properties.connectionStrings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ConnStringInfo"

name

name: "Composite" = "Composite"

cors

cors: object

serializedName

serializedName: string = "properties.cors"

type

type: object

className

className: string = "CorsSettings"

name

name: "Composite" = "Composite"

defaultDocuments

defaultDocuments: object

serializedName

serializedName: string = "properties.defaultDocuments"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

detailedErrorLoggingEnabled

detailedErrorLoggingEnabled: object

serializedName

serializedName: string = "properties.detailedErrorLoggingEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

documentRoot

documentRoot: object

serializedName

serializedName: string = "properties.documentRoot"

type

type: object

name

name: "String" = "String"

experiments

experiments: object

serializedName

serializedName: string = "properties.experiments"

type

type: object

className

className: string = "Experiments"

name

name: "Composite" = "Composite"

ftpsState

ftpsState: object

serializedName

serializedName: string = "properties.ftpsState"

type

type: object

name

name: "String" = "String"

handlerMappings

handlerMappings: object

serializedName

serializedName: string = "properties.handlerMappings"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HandlerMapping"

name

name: "Composite" = "Composite"

http20Enabled

http20Enabled: object

defaultValue

defaultValue: boolean = true

serializedName

serializedName: string = "properties.http20Enabled"

type

type: object

name

name: "Boolean" = "Boolean"

httpLoggingEnabled

httpLoggingEnabled: object

serializedName

serializedName: string = "properties.httpLoggingEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

ipSecurityRestrictions

ipSecurityRestrictions: object

serializedName

serializedName: string = "properties.ipSecurityRestrictions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpSecurityRestriction"

name

name: "Composite" = "Composite"

javaContainer

javaContainer: object

serializedName

serializedName: string = "properties.javaContainer"

type

type: object

name

name: "String" = "String"

javaContainerVersion

javaContainerVersion: object

serializedName

serializedName: string = "properties.javaContainerVersion"

type

type: object

name

name: "String" = "String"

javaVersion

javaVersion: object

serializedName

serializedName: string = "properties.javaVersion"

type

type: object

name

name: "String" = "String"

limits

limits: object

serializedName

serializedName: string = "properties.limits"

type

type: object

className

className: string = "SiteLimits"

name

name: "Composite" = "Composite"

linuxFxVersion

linuxFxVersion: object

serializedName

serializedName: string = "properties.linuxFxVersion"

type

type: object

name

name: "String" = "String"

loadBalancing

loadBalancing: object

serializedName

serializedName: string = "properties.loadBalancing"

type

type: object

allowedValues

allowedValues: string[] = ["WeightedRoundRobin","LeastRequests","LeastResponseTime","WeightedTotalTraffic","RequestHash"]

name

name: "Enum" = "Enum"

localMySqlEnabled

localMySqlEnabled: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.localMySqlEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

logsDirectorySizeLimit

logsDirectorySizeLimit: object

serializedName

serializedName: string = "properties.logsDirectorySizeLimit"

type

type: object

name

name: "Number" = "Number"

machineKey

machineKey: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.machineKey"

type

type: object

className

className: string = "SiteMachineKey"

name

name: "Composite" = "Composite"

managedPipelineMode

managedPipelineMode: object

serializedName

serializedName: string = "properties.managedPipelineMode"

type

type: object

allowedValues

allowedValues: string[] = ["Integrated","Classic"]

name

name: "Enum" = "Enum"

managedServiceIdentityId

managedServiceIdentityId: object

serializedName

serializedName: string = "properties.managedServiceIdentityId"

type

type: object

name

name: "Number" = "Number"

minTlsVersion

minTlsVersion: object

serializedName

serializedName: string = "properties.minTlsVersion"

type

type: object

name

name: "String" = "String"

netFrameworkVersion

netFrameworkVersion: object

defaultValue

defaultValue: string = "v4.6"

serializedName

serializedName: string = "properties.netFrameworkVersion"

type

type: object

name

name: "String" = "String"

nodeVersion

nodeVersion: object

serializedName

serializedName: string = "properties.nodeVersion"

type

type: object

name

name: "String" = "String"

numberOfWorkers

numberOfWorkers: object

serializedName

serializedName: string = "properties.numberOfWorkers"

type

type: object

name

name: "Number" = "Number"

phpVersion

phpVersion: object

serializedName

serializedName: string = "properties.phpVersion"

type

type: object

name

name: "String" = "String"

publishingUsername

publishingUsername: object

serializedName

serializedName: string = "properties.publishingUsername"

type

type: object

name

name: "String" = "String"

push

push: object

serializedName

serializedName: string = "properties.push"

type

type: object

className

className: string = "PushSettings"

name

name: "Composite" = "Composite"

pythonVersion

pythonVersion: object

serializedName

serializedName: string = "properties.pythonVersion"

type

type: object

name

name: "String" = "String"

remoteDebuggingEnabled

remoteDebuggingEnabled: object

serializedName

serializedName: string = "properties.remoteDebuggingEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

remoteDebuggingVersion

remoteDebuggingVersion: object

serializedName

serializedName: string = "properties.remoteDebuggingVersion"

type

type: object

name

name: "String" = "String"

requestTracingEnabled

requestTracingEnabled: object

serializedName

serializedName: string = "properties.requestTracingEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

requestTracingExpirationTime

requestTracingExpirationTime: object

serializedName

serializedName: string = "properties.requestTracingExpirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

reservedInstanceCount

reservedInstanceCount: object

serializedName

serializedName: string = "properties.reservedInstanceCount"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 10

InclusiveMinimum

InclusiveMinimum: number = 0

type

type: object

name

name: "Number" = "Number"

scmIpSecurityRestrictions

scmIpSecurityRestrictions: object

serializedName

serializedName: string = "properties.scmIpSecurityRestrictions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IpSecurityRestriction"

name

name: "Composite" = "Composite"

scmIpSecurityRestrictionsUseMain

scmIpSecurityRestrictionsUseMain: object

serializedName

serializedName: string = "properties.scmIpSecurityRestrictionsUseMain"

type

type: object

name

name: "Boolean" = "Boolean"

scmType

scmType: object

serializedName

serializedName: string = "properties.scmType"

type

type: object

name

name: "String" = "String"

tracingOptions

tracingOptions: object

serializedName

serializedName: string = "properties.tracingOptions"

type

type: object

name

name: "String" = "String"

use32BitWorkerProcess

use32BitWorkerProcess: object

serializedName

serializedName: string = "properties.use32BitWorkerProcess"

type

type: object

name

name: "Boolean" = "Boolean"

virtualApplications

virtualApplications: object

serializedName

serializedName: string = "properties.virtualApplications"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualApplication"

name

name: "Composite" = "Composite"

vnetName

vnetName: object

serializedName

serializedName: string = "properties.vnetName"

type

type: object

name

name: "String" = "String"

webSocketsEnabled

webSocketsEnabled: object

serializedName

serializedName: string = "properties.webSocketsEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

windowsFxVersion

windowsFxVersion: object

serializedName

serializedName: string = "properties.windowsFxVersion"

type

type: object

name

name: "String" = "String"

xManagedServiceIdentityId

xManagedServiceIdentityId: object

serializedName

serializedName: string = "properties.xManagedServiceIdentityId"

type

type: object

name

name: "Number" = "Number"

Const SiteConfigResourceCollection

SiteConfigResourceCollection: object
interface

Collection of site configurations.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteConfigResourceCollection"

__@iterator

  • __@iterator(): IterableIterator<SiteConfigResource>
  • Iterator

    Returns IterableIterator<SiteConfigResource>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SiteConfigResource>[]): SiteConfigResource[]
  • concat(...items: (T | ConcatArray<T>)[]): SiteConfigResource[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SiteConfigResource>[]

      Additional items to add to the end of array1.

    Returns SiteConfigResource[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SiteConfigResource[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SiteConfigResource]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SiteConfigResource]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SiteConfigResource, index: number, array: SiteConfigResource[]): boolean
        • Parameters

          • value: SiteConfigResource
          • index: number
          • array: SiteConfigResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SiteConfigResource, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SiteConfigResource

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SiteConfigResource[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SiteConfigResource

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SiteConfigResource, index: number, array: SiteConfigResource[]): boolean
        • Parameters

          • value: SiteConfigResource
          • index: number
          • array: SiteConfigResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SiteConfigResource, index: number, array: SiteConfigResource[]): any
        • Parameters

          • value: SiteConfigResource
          • index: number
          • array: SiteConfigResource[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SiteConfigResource[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SiteConfigResource | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SiteConfigResource

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SiteConfigResource, index: number, obj: SiteConfigResource[]): boolean
        • Parameters

          • this: void
          • value: SiteConfigResource
          • index: number
          • obj: SiteConfigResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SiteConfigResource, index: number, obj: SiteConfigResource[]): boolean
        • Parameters

          • value: SiteConfigResource
          • index: number
          • obj: SiteConfigResource[]

          Returns boolean

    • Optional thisArg: any

    Returns SiteConfigResource | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SiteConfigResource, index: number, obj: SiteConfigResource[]): boolean
        • Parameters

          • value: SiteConfigResource
          • index: number
          • obj: SiteConfigResource[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SiteConfigResource, index: number, array: SiteConfigResource[]): void
        • Parameters

          • value: SiteConfigResource
          • index: number
          • array: SiteConfigResource[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SiteConfigResource, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SiteConfigResource

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SiteConfigResource, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SiteConfigResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SiteConfigResource, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SiteConfigResource

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SiteConfigResource, index: number, array: SiteConfigResource[]): U
        • Parameters

          • value: SiteConfigResource
          • index: number
          • array: SiteConfigResource[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SiteConfigResource | undefined
  • Removes the last element from an array and returns it.

    Returns SiteConfigResource | undefined

push

  • push(...items: SiteConfigResource[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SiteConfigResource[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SiteConfigResource
  • reduce(callbackfn: function, initialValue: SiteConfigResource): SiteConfigResource
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SiteConfigResource, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): SiteConfigResource
        • Parameters

          • previousValue: SiteConfigResource
          • currentValue: SiteConfigResource
          • currentIndex: number
          • array: SiteConfigResource[]

          Returns SiteConfigResource

    Returns SiteConfigResource

  • Parameters

    • callbackfn: function
        • (previousValue: SiteConfigResource, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): SiteConfigResource
        • Parameters

          • previousValue: SiteConfigResource
          • currentValue: SiteConfigResource
          • currentIndex: number
          • array: SiteConfigResource[]

          Returns SiteConfigResource

    • initialValue: SiteConfigResource

    Returns SiteConfigResource

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: SiteConfigResource
          • currentIndex: number
          • array: SiteConfigResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SiteConfigResource
  • reduceRight(callbackfn: function, initialValue: SiteConfigResource): SiteConfigResource
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SiteConfigResource, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): SiteConfigResource
        • Parameters

          • previousValue: SiteConfigResource
          • currentValue: SiteConfigResource
          • currentIndex: number
          • array: SiteConfigResource[]

          Returns SiteConfigResource

    Returns SiteConfigResource

  • Parameters

    • callbackfn: function
        • (previousValue: SiteConfigResource, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): SiteConfigResource
        • Parameters

          • previousValue: SiteConfigResource
          • currentValue: SiteConfigResource
          • currentIndex: number
          • array: SiteConfigResource[]

          Returns SiteConfigResource

    • initialValue: SiteConfigResource

    Returns SiteConfigResource

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): U
        • Parameters

          • previousValue: U
          • currentValue: SiteConfigResource
          • currentIndex: number
          • array: SiteConfigResource[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SiteConfigResource[]
  • Reverses the elements in an Array.

    Returns SiteConfigResource[]

shift

  • shift(): SiteConfigResource | undefined
  • Removes the first element from an array and returns it.

    Returns SiteConfigResource | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SiteConfigResource[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SiteConfigResource[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SiteConfigResource, index: number, array: SiteConfigResource[]): boolean
        • Parameters

          • value: SiteConfigResource
          • index: number
          • array: SiteConfigResource[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SiteConfigResource[]
  • splice(start: number, deleteCount: number, ...items: SiteConfigResource[]): SiteConfigResource[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SiteConfigResource[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SiteConfigResource[]

      Elements to insert into the array in place of the deleted elements.

    Returns SiteConfigResource[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SiteConfigResource[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SiteConfigResource[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SiteConfigResource>
  • Returns an iterable of values in the array

    Returns IterableIterator<SiteConfigResource>

type

type: object

className

className: string = "SiteConfigResourceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SiteConfigResource"

name

name: "Composite" = "Composite"

Const SiteConfigurationSnapshotInfo

SiteConfigurationSnapshotInfo: object

A snapshot of a web app configuration.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteConfigurationSnapshotInfo"

Optional snapshotId

snapshotId: undefined | number

The id of the snapshot NOTE: This property will not be serialized. It can only be populated by the server.

Optional time

time: Date

The time the snapshot was taken. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SiteConfigurationSnapshotInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

snapshotId

snapshotId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.snapshotId"

type

type: object

name

name: "Number" = "Number"

time

time: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.time"

type

type: object

name

name: "DateTime" = "DateTime"

Const SiteConfigurationSnapshotInfoCollection

SiteConfigurationSnapshotInfoCollection: object
interface

Collection of metadata for the app configuration snapshots that can be restored.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteConfigurationSnapshotInfoCollection"

__@iterator

  • __@iterator(): IterableIterator<SiteConfigurationSnapshotInfo>
  • Iterator

    Returns IterableIterator<SiteConfigurationSnapshotInfo>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SiteConfigurationSnapshotInfo>[]): SiteConfigurationSnapshotInfo[]
  • concat(...items: (T | ConcatArray<T>)[]): SiteConfigurationSnapshotInfo[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SiteConfigurationSnapshotInfo>[]

      Additional items to add to the end of array1.

    Returns SiteConfigurationSnapshotInfo[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SiteConfigurationSnapshotInfo[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SiteConfigurationSnapshotInfo]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SiteConfigurationSnapshotInfo]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): boolean
        • Parameters

          • value: SiteConfigurationSnapshotInfo
          • index: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SiteConfigurationSnapshotInfo, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SiteConfigurationSnapshotInfo

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SiteConfigurationSnapshotInfo[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SiteConfigurationSnapshotInfo

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): boolean
        • Parameters

          • value: SiteConfigurationSnapshotInfo
          • index: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): any
        • Parameters

          • value: SiteConfigurationSnapshotInfo
          • index: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SiteConfigurationSnapshotInfo[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SiteConfigurationSnapshotInfo | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SiteConfigurationSnapshotInfo

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SiteConfigurationSnapshotInfo, index: number, obj: SiteConfigurationSnapshotInfo[]): boolean
        • Parameters

          • this: void
          • value: SiteConfigurationSnapshotInfo
          • index: number
          • obj: SiteConfigurationSnapshotInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SiteConfigurationSnapshotInfo, index: number, obj: SiteConfigurationSnapshotInfo[]): boolean
        • Parameters

          • value: SiteConfigurationSnapshotInfo
          • index: number
          • obj: SiteConfigurationSnapshotInfo[]

          Returns boolean

    • Optional thisArg: any

    Returns SiteConfigurationSnapshotInfo | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SiteConfigurationSnapshotInfo, index: number, obj: SiteConfigurationSnapshotInfo[]): boolean
        • Parameters

          • value: SiteConfigurationSnapshotInfo
          • index: number
          • obj: SiteConfigurationSnapshotInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): void
        • Parameters

          • value: SiteConfigurationSnapshotInfo
          • index: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SiteConfigurationSnapshotInfo, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SiteConfigurationSnapshotInfo

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SiteConfigurationSnapshotInfo, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SiteConfigurationSnapshotInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SiteConfigurationSnapshotInfo, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SiteConfigurationSnapshotInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): U
        • Parameters

          • value: SiteConfigurationSnapshotInfo
          • index: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SiteConfigurationSnapshotInfo | undefined
  • Removes the last element from an array and returns it.

    Returns SiteConfigurationSnapshotInfo | undefined

push

  • push(...items: SiteConfigurationSnapshotInfo[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SiteConfigurationSnapshotInfo[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SiteConfigurationSnapshotInfo
  • reduce(callbackfn: function, initialValue: SiteConfigurationSnapshotInfo): SiteConfigurationSnapshotInfo
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SiteConfigurationSnapshotInfo, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo
        • Parameters

          • previousValue: SiteConfigurationSnapshotInfo
          • currentValue: SiteConfigurationSnapshotInfo
          • currentIndex: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns SiteConfigurationSnapshotInfo

    Returns SiteConfigurationSnapshotInfo

  • Parameters

    • callbackfn: function
        • (previousValue: SiteConfigurationSnapshotInfo, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo
        • Parameters

          • previousValue: SiteConfigurationSnapshotInfo
          • currentValue: SiteConfigurationSnapshotInfo
          • currentIndex: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns SiteConfigurationSnapshotInfo

    • initialValue: SiteConfigurationSnapshotInfo

    Returns SiteConfigurationSnapshotInfo

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: SiteConfigurationSnapshotInfo
          • currentIndex: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SiteConfigurationSnapshotInfo
  • reduceRight(callbackfn: function, initialValue: SiteConfigurationSnapshotInfo): SiteConfigurationSnapshotInfo
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SiteConfigurationSnapshotInfo, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo
        • Parameters

          • previousValue: SiteConfigurationSnapshotInfo
          • currentValue: SiteConfigurationSnapshotInfo
          • currentIndex: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns SiteConfigurationSnapshotInfo

    Returns SiteConfigurationSnapshotInfo

  • Parameters

    • callbackfn: function
        • (previousValue: SiteConfigurationSnapshotInfo, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo
        • Parameters

          • previousValue: SiteConfigurationSnapshotInfo
          • currentValue: SiteConfigurationSnapshotInfo
          • currentIndex: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns SiteConfigurationSnapshotInfo

    • initialValue: SiteConfigurationSnapshotInfo

    Returns SiteConfigurationSnapshotInfo

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: SiteConfigurationSnapshotInfo
          • currentIndex: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SiteConfigurationSnapshotInfo[]
  • Reverses the elements in an Array.

    Returns SiteConfigurationSnapshotInfo[]

shift

  • shift(): SiteConfigurationSnapshotInfo | undefined
  • Removes the first element from an array and returns it.

    Returns SiteConfigurationSnapshotInfo | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SiteConfigurationSnapshotInfo[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SiteConfigurationSnapshotInfo[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): boolean
        • Parameters

          • value: SiteConfigurationSnapshotInfo
          • index: number
          • array: SiteConfigurationSnapshotInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SiteConfigurationSnapshotInfo[]
  • splice(start: number, deleteCount: number, ...items: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SiteConfigurationSnapshotInfo[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SiteConfigurationSnapshotInfo[]

      Elements to insert into the array in place of the deleted elements.

    Returns SiteConfigurationSnapshotInfo[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SiteConfigurationSnapshotInfo[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SiteConfigurationSnapshotInfo[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SiteConfigurationSnapshotInfo>
  • Returns an iterable of values in the array

    Returns IterableIterator<SiteConfigurationSnapshotInfo>

type

type: object

className

className: string = "SiteConfigurationSnapshotInfoCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SiteConfigurationSnapshotInfo"

name

name: "Composite" = "Composite"

Const SiteExtensionInfo

SiteExtensionInfo: object

Site Extension Information.

Optional authors

authors: string[]

List of authors.

Optional comment

comment: undefined | string

Site Extension comment.

Optional description

description: undefined | string

Detailed description.

Optional downloadCount

downloadCount: undefined | number

Count of downloads.

Optional extensionId

extensionId: undefined | string

Site extension ID.

Optional extensionType

extensionType: SiteExtensionType

Site extension type. Possible values include: 'Gallery', 'WebRoot'

Optional extensionUrl

extensionUrl: undefined | string

Extension URL.

Optional feedUrl

feedUrl: undefined | string

Feed URL.

Optional iconUrl

iconUrl: undefined | string

Icon URL.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional installedDateTime

installedDateTime: Date

Installed timestamp.

Optional installerCommandLineParams

installerCommandLineParams: undefined | string

Installer command line parameters.

Optional kind

kind: undefined | string

Kind of resource.

Optional licenseUrl

licenseUrl: undefined | string

License URL.

Optional localIsLatestVersion

localIsLatestVersion: undefined | false | true

true if the local version is the latest version; false otherwise.

Optional localPath

localPath: undefined | string

Local path.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional projectUrl

projectUrl: undefined | string

Project URL.

Optional provisioningState

provisioningState: undefined | string

Provisioning state.

Optional publishedDateTime

publishedDateTime: Date

Published timestamp.

serializedName

serializedName: string = "SiteExtensionInfo"

Optional summary

summary: undefined | string

Summary description.

Optional title

title: undefined | string

Optional version

version: undefined | string

Version information.

type

type: object

className

className: string = "SiteExtensionInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authors

authors: object

serializedName

serializedName: string = "properties.authors"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

comment

comment: object

serializedName

serializedName: string = "properties.comment"

type

type: object

name

name: "String" = "String"

description

description: object

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

downloadCount

downloadCount: object

serializedName

serializedName: string = "properties.download_count"

type

type: object

name

name: "Number" = "Number"

extensionId

extensionId: object

serializedName

serializedName: string = "properties.extension_id"

type

type: object

name

name: "String" = "String"

extensionType

extensionType: object

serializedName

serializedName: string = "properties.extension_type"

type

type: object

allowedValues

allowedValues: string[] = ["Gallery","WebRoot"]

name

name: "Enum" = "Enum"

extensionUrl

extensionUrl: object

serializedName

serializedName: string = "properties.extension_url"

type

type: object

name

name: "String" = "String"

feedUrl

feedUrl: object

serializedName

serializedName: string = "properties.feed_url"

type

type: object

name

name: "String" = "String"

iconUrl

iconUrl: object

serializedName

serializedName: string = "properties.icon_url"

type

type: object

name

name: "String" = "String"

installedDateTime

installedDateTime: object

serializedName

serializedName: string = "properties.installed_date_time"

type

type: object

name

name: "DateTime" = "DateTime"

installerCommandLineParams

installerCommandLineParams: object

serializedName

serializedName: string = "properties.installer_command_line_params"

type

type: object

name

name: "String" = "String"

licenseUrl

licenseUrl: object

serializedName

serializedName: string = "properties.license_url"

type

type: object

name

name: "String" = "String"

localIsLatestVersion

localIsLatestVersion: object

serializedName

serializedName: string = "properties.local_is_latest_version"

type

type: object

name

name: "Boolean" = "Boolean"

localPath

localPath: object

serializedName

serializedName: string = "properties.local_path"

type

type: object

name

name: "String" = "String"

projectUrl

projectUrl: object

serializedName

serializedName: string = "properties.project_url"

type

type: object

name

name: "String" = "String"

provisioningState

provisioningState: object

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

publishedDateTime

publishedDateTime: object

serializedName

serializedName: string = "properties.published_date_time"

type

type: object

name

name: "DateTime" = "DateTime"

summary

summary: object

serializedName

serializedName: string = "properties.summary"

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "properties.title"

type

type: object

name

name: "String" = "String"

version

version: object

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "String" = "String"

Const SiteExtensionInfoCollection

SiteExtensionInfoCollection: object
interface

Collection of Kudu site extension information elements.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteExtensionInfoCollection"

__@iterator

  • __@iterator(): IterableIterator<SiteExtensionInfo>
  • Iterator

    Returns IterableIterator<SiteExtensionInfo>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SiteExtensionInfo>[]): SiteExtensionInfo[]
  • concat(...items: (T | ConcatArray<T>)[]): SiteExtensionInfo[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SiteExtensionInfo>[]

      Additional items to add to the end of array1.

    Returns SiteExtensionInfo[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SiteExtensionInfo[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SiteExtensionInfo]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SiteExtensionInfo]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): boolean
        • Parameters

          • value: SiteExtensionInfo
          • index: number
          • array: SiteExtensionInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SiteExtensionInfo, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SiteExtensionInfo

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SiteExtensionInfo[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SiteExtensionInfo

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): boolean
        • Parameters

          • value: SiteExtensionInfo
          • index: number
          • array: SiteExtensionInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): any
        • Parameters

          • value: SiteExtensionInfo
          • index: number
          • array: SiteExtensionInfo[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SiteExtensionInfo[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SiteExtensionInfo | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SiteExtensionInfo

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SiteExtensionInfo, index: number, obj: SiteExtensionInfo[]): boolean
        • Parameters

          • this: void
          • value: SiteExtensionInfo
          • index: number
          • obj: SiteExtensionInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SiteExtensionInfo, index: number, obj: SiteExtensionInfo[]): boolean
        • Parameters

          • value: SiteExtensionInfo
          • index: number
          • obj: SiteExtensionInfo[]

          Returns boolean

    • Optional thisArg: any

    Returns SiteExtensionInfo | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SiteExtensionInfo, index: number, obj: SiteExtensionInfo[]): boolean
        • Parameters

          • value: SiteExtensionInfo
          • index: number
          • obj: SiteExtensionInfo[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): void
        • Parameters

          • value: SiteExtensionInfo
          • index: number
          • array: SiteExtensionInfo[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SiteExtensionInfo, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SiteExtensionInfo

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SiteExtensionInfo, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SiteExtensionInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SiteExtensionInfo, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SiteExtensionInfo

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): U
        • Parameters

          • value: SiteExtensionInfo
          • index: number
          • array: SiteExtensionInfo[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SiteExtensionInfo | undefined
  • Removes the last element from an array and returns it.

    Returns SiteExtensionInfo | undefined

push

  • push(...items: SiteExtensionInfo[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SiteExtensionInfo[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SiteExtensionInfo
  • reduce(callbackfn: function, initialValue: SiteExtensionInfo): SiteExtensionInfo
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SiteExtensionInfo, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): SiteExtensionInfo
        • Parameters

          • previousValue: SiteExtensionInfo
          • currentValue: SiteExtensionInfo
          • currentIndex: number
          • array: SiteExtensionInfo[]

          Returns SiteExtensionInfo

    Returns SiteExtensionInfo

  • Parameters

    • callbackfn: function
        • (previousValue: SiteExtensionInfo, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): SiteExtensionInfo
        • Parameters

          • previousValue: SiteExtensionInfo
          • currentValue: SiteExtensionInfo
          • currentIndex: number
          • array: SiteExtensionInfo[]

          Returns SiteExtensionInfo

    • initialValue: SiteExtensionInfo

    Returns SiteExtensionInfo

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: SiteExtensionInfo
          • currentIndex: number
          • array: SiteExtensionInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SiteExtensionInfo
  • reduceRight(callbackfn: function, initialValue: SiteExtensionInfo): SiteExtensionInfo
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SiteExtensionInfo, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): SiteExtensionInfo
        • Parameters

          • previousValue: SiteExtensionInfo
          • currentValue: SiteExtensionInfo
          • currentIndex: number
          • array: SiteExtensionInfo[]

          Returns SiteExtensionInfo

    Returns SiteExtensionInfo

  • Parameters

    • callbackfn: function
        • (previousValue: SiteExtensionInfo, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): SiteExtensionInfo
        • Parameters

          • previousValue: SiteExtensionInfo
          • currentValue: SiteExtensionInfo
          • currentIndex: number
          • array: SiteExtensionInfo[]

          Returns SiteExtensionInfo

    • initialValue: SiteExtensionInfo

    Returns SiteExtensionInfo

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): U
        • Parameters

          • previousValue: U
          • currentValue: SiteExtensionInfo
          • currentIndex: number
          • array: SiteExtensionInfo[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SiteExtensionInfo[]
  • Reverses the elements in an Array.

    Returns SiteExtensionInfo[]

shift

  • shift(): SiteExtensionInfo | undefined
  • Removes the first element from an array and returns it.

    Returns SiteExtensionInfo | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SiteExtensionInfo[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SiteExtensionInfo[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): boolean
        • Parameters

          • value: SiteExtensionInfo
          • index: number
          • array: SiteExtensionInfo[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SiteExtensionInfo[]
  • splice(start: number, deleteCount: number, ...items: SiteExtensionInfo[]): SiteExtensionInfo[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SiteExtensionInfo[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SiteExtensionInfo[]

      Elements to insert into the array in place of the deleted elements.

    Returns SiteExtensionInfo[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SiteExtensionInfo[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SiteExtensionInfo[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SiteExtensionInfo>
  • Returns an iterable of values in the array

    Returns IterableIterator<SiteExtensionInfo>

type

type: object

className

className: string = "SiteExtensionInfoCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SiteExtensionInfo"

name

name: "Composite" = "Composite"

Const SiteInstance

SiteInstance: object

Instance of an app.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteInstance"

Optional siteInstanceName

siteInstanceName: undefined | string

Name of instance. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SiteInstance"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

siteInstanceName

siteInstanceName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.siteInstanceName"

type

type: object

name

name: "String" = "String"

Const SiteLimits

SiteLimits: object

Metric limits set on an app.

Optional maxDiskSizeInMb

maxDiskSizeInMb: undefined | number

Maximum allowed disk size usage in MB.

Optional maxMemoryInMb

maxMemoryInMb: undefined | number

Maximum allowed memory usage in MB.

Optional maxPercentageCpu

maxPercentageCpu: undefined | number

Maximum allowed CPU usage percentage.

serializedName

serializedName: string = "SiteLimits"

type

type: object

className

className: string = "SiteLimits"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

maxDiskSizeInMb

maxDiskSizeInMb: object

serializedName

serializedName: string = "maxDiskSizeInMb"

type

type: object

name

name: "Number" = "Number"

maxMemoryInMb

maxMemoryInMb: object

serializedName

serializedName: string = "maxMemoryInMb"

type

type: object

name

name: "Number" = "Number"

maxPercentageCpu

maxPercentageCpu: object

serializedName

serializedName: string = "maxPercentageCpu"

type

type: object

name

name: "Number" = "Number"

Const SiteLogsConfig

SiteLogsConfig: object

Configuration of App Service site logs.

Optional applicationLogs

applicationLogs: ApplicationLogsConfig

Application logs configuration.

Optional detailedErrorMessages

detailedErrorMessages: EnabledConfig

Detailed error messages configuration.

Optional failedRequestsTracing

failedRequestsTracing: EnabledConfig

Failed requests tracing configuration.

Optional httpLogs

httpLogs: HttpLogsConfig

HTTP logs configuration.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteLogsConfig"

type

type: object

className

className: string = "SiteLogsConfig"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationLogs

applicationLogs: object

serializedName

serializedName: string = "properties.applicationLogs"

type

type: object

className

className: string = "ApplicationLogsConfig"

name

name: "Composite" = "Composite"

detailedErrorMessages

detailedErrorMessages: object

serializedName

serializedName: string = "properties.detailedErrorMessages"

type

type: object

className

className: string = "EnabledConfig"

name

name: "Composite" = "Composite"

failedRequestsTracing

failedRequestsTracing: object

serializedName

serializedName: string = "properties.failedRequestsTracing"

type

type: object

className

className: string = "EnabledConfig"

name

name: "Composite" = "Composite"

httpLogs

httpLogs: object

serializedName

serializedName: string = "properties.httpLogs"

type

type: object

className

className: string = "HttpLogsConfig"

name

name: "Composite" = "Composite"

Const SiteMachineKey

SiteMachineKey: object

MachineKey of an app.

Optional decryption

decryption: undefined | string

Algorithm used for decryption.

Optional decryptionKey

decryptionKey: undefined | string

Decryption key.

serializedName

serializedName: string = "SiteMachineKey"

Optional validation

validation: undefined | string

MachineKey validation.

Optional validationKey

validationKey: undefined | string

Validation key.

type

type: object

className

className: string = "SiteMachineKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

decryption

decryption: object

serializedName

serializedName: string = "decryption"

type

type: object

name

name: "String" = "String"

decryptionKey

decryptionKey: object

serializedName

serializedName: string = "decryptionKey"

type

type: object

name

name: "String" = "String"

validation

validation: object

serializedName

serializedName: string = "validation"

type

type: object

name

name: "String" = "String"

validationKey

validationKey: object

serializedName

serializedName: string = "validationKey"

type

type: object

name

name: "String" = "String"

Const SitePatchResource

SitePatchResource: object

ARM resource for a site.

Optional availabilityState

availabilityState: SiteAvailabilityState

Management information availability state for the app. Possible values include: 'Normal', 'Limited', 'DisasterRecoveryMode' NOTE: This property will not be serialized. It can only be populated by the server.

Optional clientAffinityEnabled

clientAffinityEnabled: undefined | false | true

true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

Optional clientCertEnabled

clientCertEnabled: undefined | false | true

true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

Optional clientCertExclusionPaths

clientCertExclusionPaths: undefined | string

client certificate authentication comma-separated exclusion paths

Optional cloningInfo

cloningInfo: CloningInfo

If specified during app creation, the app is cloned from a source app.

Optional containerSize

containerSize: undefined | number

Size of the function container.

Optional dailyMemoryTimeQuota

dailyMemoryTimeQuota: undefined | number

Maximum allowed daily memory-time quota (applicable on dynamic apps only).

Optional defaultHostName

defaultHostName: undefined | string

Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enabled

enabled: undefined | false | true

true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

Optional enabledHostNames

enabledHostNames: string[]

Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. NOTE: This property will not be serialized. It can only be populated by the server.

Optional geoDistributions

geoDistributions: GeoDistribution[]

GeoDistributions for this site

Optional hostNameSslStates

hostNameSslStates: HostNameSslState[]

Hostname SSL states are used to manage the SSL bindings for app's hostnames.

Optional hostNames

hostNames: string[]

Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNamesDisabled

hostNamesDisabled: undefined | false | true

true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

App Service Environment to use for the app.

Optional httpsOnly

httpsOnly: undefined | false | true

HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

Optional hyperV

hyperV: undefined | false | true

Hyper-V sandbox. Default value: false.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

Optional inProgressOperationId

inProgressOperationId: undefined | string

Specifies an operation id if this site has a pending operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDefaultContainer

isDefaultContainer: undefined | false | true

true if the app is a default container; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isXenon

isXenon: undefined | false | true

Obsolete: Hyper-V sandbox. Default value: false.

Optional kind

kind: undefined | string

Kind of resource.

Optional lastModifiedTimeUtc

lastModifiedTimeUtc: Date

Last time the app was modified, in UTC. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxNumberOfWorkers

maxNumberOfWorkers: undefined | number

Maximum number of workers. This only applies to Functions container. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outboundIpAddresses

outboundIpAddresses: undefined | string

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional possibleOutboundIpAddresses

possibleOutboundIpAddresses: undefined | string

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional redundancyMode

redundancyMode: RedundancyMode

Site redundancy mode. Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive', 'GeoRedundant'

Optional repositorySiteName

repositorySiteName: undefined | string

Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reserved

reserved: undefined | false | true

true if reserved; otherwise, false. Default value: false.

Optional resourceGroup

resourceGroup: undefined | string

Name of the resource group the app belongs to. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scmSiteAlsoStopped

scmSiteAlsoStopped: undefined | false | true

true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. Default value: false.

serializedName

serializedName: string = "SitePatchResource"

Optional serverFarmId

serverFarmId: undefined | string

Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Optional siteConfig

siteConfig: SiteConfig

Configuration of the app.

Optional slotSwapStatus

slotSwapStatus: SlotSwapStatus

Status of the last deployment slot swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: undefined | string

Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server.

Optional suspendedTill

suspendedTill: Date

App suspended till in case memory-time quota is exceeded. NOTE: This property will not be serialized. It can only be populated by the server.

Optional targetSwapSlot

targetSwapSlot: undefined | string

Specifies which deployment slot this app will swap into. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trafficManagerHostNames

trafficManagerHostNames: string[]

Azure Traffic Manager hostnames associated with the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usageState

usageState: UsageState

State indicating whether the app has exceeded its quota usage. Read-only. Possible values include: 'Normal', 'Exceeded' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SitePatchResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

availabilityState

availabilityState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.availabilityState"

type

type: object

allowedValues

allowedValues: string[] = ["Normal","Limited","DisasterRecoveryMode"]

name

name: "Enum" = "Enum"

clientAffinityEnabled

clientAffinityEnabled: object

serializedName

serializedName: string = "properties.clientAffinityEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

clientCertEnabled

clientCertEnabled: object

serializedName

serializedName: string = "properties.clientCertEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

clientCertExclusionPaths

clientCertExclusionPaths: object

serializedName

serializedName: string = "properties.clientCertExclusionPaths"

type

type: object

name

name: "String" = "String"

cloningInfo

cloningInfo: object

serializedName

serializedName: string = "properties.cloningInfo"

type

type: object

className

className: string = "CloningInfo"

name

name: "Composite" = "Composite"

containerSize

containerSize: object

serializedName

serializedName: string = "properties.containerSize"

type

type: object

name

name: "Number" = "Number"

dailyMemoryTimeQuota

dailyMemoryTimeQuota: object

serializedName

serializedName: string = "properties.dailyMemoryTimeQuota"

type

type: object

name

name: "Number" = "Number"

defaultHostName

defaultHostName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.defaultHostName"

type

type: object

name

name: "String" = "String"

enabled

enabled: object

serializedName

serializedName: string = "properties.enabled"

type

type: object

name

name: "Boolean" = "Boolean"

enabledHostNames

enabledHostNames: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.enabledHostNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

geoDistributions

geoDistributions: object

serializedName

serializedName: string = "properties.geoDistributions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GeoDistribution"

name

name: "Composite" = "Composite"

hostNameSslStates

hostNameSslStates: object

serializedName

serializedName: string = "properties.hostNameSslStates"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "HostNameSslState"

name

name: "Composite" = "Composite"

hostNames

hostNames: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hostNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

hostNamesDisabled

hostNamesDisabled: object

serializedName

serializedName: string = "properties.hostNamesDisabled"

type

type: object

name

name: "Boolean" = "Boolean"

hostingEnvironmentProfile

hostingEnvironmentProfile: object

serializedName

serializedName: string = "properties.hostingEnvironmentProfile"

type

type: object

className

className: string = "HostingEnvironmentProfile"

name

name: "Composite" = "Composite"

httpsOnly

httpsOnly: object

serializedName

serializedName: string = "properties.httpsOnly"

type

type: object

name

name: "Boolean" = "Boolean"

hyperV

hyperV: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.hyperV"

type

type: object

name

name: "Boolean" = "Boolean"

identity

identity: object

serializedName

serializedName: string = "identity"

type

type: object

className

className: string = "ManagedServiceIdentity"

name

name: "Composite" = "Composite"

inProgressOperationId

inProgressOperationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inProgressOperationId"

type

type: object

name

name: "Uuid" = "Uuid"

isDefaultContainer

isDefaultContainer: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.isDefaultContainer"

type

type: object

name

name: "Boolean" = "Boolean"

isXenon

isXenon: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.isXenon"

type

type: object

name

name: "Boolean" = "Boolean"

lastModifiedTimeUtc

lastModifiedTimeUtc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastModifiedTimeUtc"

type

type: object

name

name: "DateTime" = "DateTime"

maxNumberOfWorkers

maxNumberOfWorkers: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maxNumberOfWorkers"

type

type: object

name

name: "Number" = "Number"

outboundIpAddresses

outboundIpAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outboundIpAddresses"

type

type: object

name

name: "String" = "String"

possibleOutboundIpAddresses

possibleOutboundIpAddresses: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.possibleOutboundIpAddresses"

type

type: object

name

name: "String" = "String"

redundancyMode

redundancyMode: object

serializedName

serializedName: string = "properties.redundancyMode"

type

type: object

allowedValues

allowedValues: string[] = ["None","Manual","Failover","ActiveActive","GeoRedundant"]

name

name: "Enum" = "Enum"

repositorySiteName

repositorySiteName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.repositorySiteName"

type

type: object

name

name: "String" = "String"

reserved

reserved: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.reserved"

type

type: object

name

name: "Boolean" = "Boolean"

resourceGroup

resourceGroup: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceGroup"

type

type: object

name

name: "String" = "String"

scmSiteAlsoStopped

scmSiteAlsoStopped: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.scmSiteAlsoStopped"

type

type: object

name

name: "Boolean" = "Boolean"

serverFarmId

serverFarmId: object

serializedName

serializedName: string = "properties.serverFarmId"

type

type: object

name

name: "String" = "String"

siteConfig

siteConfig: object

serializedName

serializedName: string = "properties.siteConfig"

type

type: object

className

className: string = "SiteConfig"

name

name: "Composite" = "Composite"

slotSwapStatus

slotSwapStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.slotSwapStatus"

type

type: object

className

className: string = "SlotSwapStatus"

name

name: "Composite" = "Composite"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

suspendedTill

suspendedTill: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.suspendedTill"

type

type: object

name

name: "DateTime" = "DateTime"

targetSwapSlot

targetSwapSlot: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.targetSwapSlot"

type

type: object

name

name: "String" = "String"

trafficManagerHostNames

trafficManagerHostNames: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.trafficManagerHostNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

usageState

usageState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.usageState"

type

type: object

allowedValues

allowedValues: string[] = ["Normal","Exceeded"]

name

name: "Enum" = "Enum"

Const SitePhpErrorLogFlag

SitePhpErrorLogFlag: object

Used for getting PHP error logging flag.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional localLogErrors

localLogErrors: undefined | string

Local log_errors setting.

Optional localLogErrorsMaxLength

localLogErrorsMaxLength: undefined | string

Local log_errors_max_len setting.

Optional masterLogErrors

masterLogErrors: undefined | string

Master log_errors setting.

Optional masterLogErrorsMaxLength

masterLogErrorsMaxLength: undefined | string

Master log_errors_max_len setting.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SitePhpErrorLogFlag"

type

type: object

className

className: string = "SitePhpErrorLogFlag"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

localLogErrors

localLogErrors: object

serializedName

serializedName: string = "properties.localLogErrors"

type

type: object

name

name: "String" = "String"

localLogErrorsMaxLength

localLogErrorsMaxLength: object

serializedName

serializedName: string = "properties.localLogErrorsMaxLength"

type

type: object

name

name: "String" = "String"

masterLogErrors

masterLogErrors: object

serializedName

serializedName: string = "properties.masterLogErrors"

type

type: object

name

name: "String" = "String"

masterLogErrorsMaxLength

masterLogErrorsMaxLength: object

serializedName

serializedName: string = "properties.masterLogErrorsMaxLength"

type

type: object

name

name: "String" = "String"

Const SiteSourceControl

SiteSourceControl: object

Source control configuration for an app.

Optional branch

branch: undefined | string

Name of branch to use for deployment.

Optional deploymentRollbackEnabled

deploymentRollbackEnabled: undefined | false | true

true to enable deployment rollback; otherwise, false.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isManualIntegration

isManualIntegration: undefined | false | true

true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).

Optional isMercurial

isMercurial: undefined | false | true

true for a Mercurial repository; false for a Git repository.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional repoUrl

repoUrl: undefined | string

Repository or source control URL.

serializedName

serializedName: string = "SiteSourceControl"

type

type: object

className

className: string = "SiteSourceControl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

branch

branch: object

serializedName

serializedName: string = "properties.branch"

type

type: object

name

name: "String" = "String"

deploymentRollbackEnabled

deploymentRollbackEnabled: object

serializedName

serializedName: string = "properties.deploymentRollbackEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

isManualIntegration

isManualIntegration: object

serializedName

serializedName: string = "properties.isManualIntegration"

type

type: object

name

name: "Boolean" = "Boolean"

isMercurial

isMercurial: object

serializedName

serializedName: string = "properties.isMercurial"

type

type: object

name

name: "Boolean" = "Boolean"

repoUrl

repoUrl: object

serializedName

serializedName: string = "properties.repoUrl"

type

type: object

name

name: "String" = "String"

Const SkuCapacity

SkuCapacity: object

Description of the App Service plan scale options.

Optional default

default: undefined | number

Default number of workers for this App Service plan SKU.

Optional maximum

maximum: undefined | number

Maximum number of workers for this App Service plan SKU.

Optional minimum

minimum: undefined | number

Minimum number of workers for this App Service plan SKU.

Optional scaleType

scaleType: undefined | string

Available scale configurations for an App Service plan.

serializedName

serializedName: string = "SkuCapacity"

type

type: object

className

className: string = "SkuCapacity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

default

default: object

serializedName

serializedName: string = "default"

type

type: object

name

name: "Number" = "Number"

maximum

maximum: object

serializedName

serializedName: string = "maximum"

type

type: object

name

name: "Number" = "Number"

minimum

minimum: object

serializedName

serializedName: string = "minimum"

type

type: object

name

name: "Number" = "Number"

scaleType

scaleType: object

serializedName

serializedName: string = "scaleType"

type

type: object

name

name: "String" = "String"

Const SkuDescription

SkuDescription: object

Description of a SKU for a scalable resource.

Optional capabilities

capabilities: Capability[]

Capabilities of the SKU, e.g., is traffic manager enabled?

Optional capacity

capacity: undefined | number

Current number of instances assigned to the resource.

Optional family

family: undefined | string

Family code of the resource SKU.

Optional locations

locations: string[]

Locations of the SKU.

Optional name

name: undefined | string

Name of the resource SKU.

serializedName

serializedName: string = "SkuDescription"

Optional size

size: undefined | string

Size specifier of the resource SKU.

Optional skuCapacity

skuCapacity: SkuCapacity

Min, max, and default scale values of the SKU.

Optional tier

tier: undefined | string

Service tier of the resource SKU.

type

type: object

className

className: string = "SkuDescription"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capabilities

capabilities: object

serializedName

serializedName: string = "capabilities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Capability"

name

name: "Composite" = "Composite"

capacity

capacity: object

serializedName

serializedName: string = "capacity"

type

type: object

name

name: "Number" = "Number"

family

family: object

serializedName

serializedName: string = "family"

type

type: object

name

name: "String" = "String"

locations

locations: object

serializedName

serializedName: string = "locations"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

size

size: object

serializedName

serializedName: string = "size"

type

type: object

name

name: "String" = "String"

skuCapacity

skuCapacity: object

serializedName

serializedName: string = "skuCapacity"

type

type: object

className

className: string = "SkuCapacity"

name

name: "Composite" = "Composite"

tier

tier: object

serializedName

serializedName: string = "tier"

type

type: object

name

name: "String" = "String"

Const SkuInfos

SkuInfos: object

Collection of SKU information.

Optional resourceType

resourceType: undefined | string

Resource type that this SKU applies to.

serializedName

serializedName: string = "SkuInfos"

Optional skus

skus: GlobalCsmSkuDescription[]

List of SKUs the subscription is able to use.

type

type: object

className

className: string = "SkuInfos"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

resourceType

resourceType: object

serializedName

serializedName: string = "resourceType"

type

type: object

name

name: "String" = "String"

skus

skus: object

serializedName

serializedName: string = "skus"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "GlobalCsmSkuDescription"

name

name: "Composite" = "Composite"

Const SlotConfigNamesResource

SlotConfigNamesResource: object

Slot Config names azure resource.

Optional appSettingNames

appSettingNames: string[]

List of application settings names.

Optional azureStorageConfigNames

azureStorageConfigNames: string[]

List of external Azure storage account identifiers.

Optional connectionStringNames

connectionStringNames: string[]

List of connection string names.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SlotConfigNamesResource"

type

type: object

className

className: string = "SlotConfigNamesResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

appSettingNames

appSettingNames: object

serializedName

serializedName: string = "properties.appSettingNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

azureStorageConfigNames

azureStorageConfigNames: object

serializedName

serializedName: string = "properties.azureStorageConfigNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

connectionStringNames

connectionStringNames: object

serializedName

serializedName: string = "properties.connectionStringNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

Const SlotDifference

SlotDifference: object

A setting difference between two deployment slots of an app.

Optional description

description: undefined | string

Description of the setting difference. NOTE: This property will not be serialized. It can only be populated by the server.

Optional diffRule

diffRule: undefined | string

Rule that describes how to process the setting difference during a slot swap. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional level

level: undefined | string

Level of the difference: Information, Warning or Error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SlotDifference"

Optional settingName

settingName: undefined | string

Name of the setting. NOTE: This property will not be serialized. It can only be populated by the server.

Optional settingType

settingType: undefined | string

The type of the setting: General, AppSetting or ConnectionString. NOTE: This property will not be serialized. It can only be populated by the server.

Optional valueInCurrentSlot

valueInCurrentSlot: undefined | string

Value of the setting in the current slot. NOTE: This property will not be serialized. It can only be populated by the server.

Optional valueInTargetSlot

valueInTargetSlot: undefined | string

Value of the setting in the target slot. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SlotDifference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

name: "String" = "String"

diffRule

diffRule: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.diffRule"

type

type: object

name

name: "String" = "String"

level

level: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.level"

type

type: object

name

name: "String" = "String"

settingName

settingName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.settingName"

type

type: object

name

name: "String" = "String"

settingType

settingType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.settingType"

type

type: object

name

name: "String" = "String"

valueInCurrentSlot

valueInCurrentSlot: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.valueInCurrentSlot"

type

type: object

name

name: "String" = "String"

valueInTargetSlot

valueInTargetSlot: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.valueInTargetSlot"

type

type: object

name

name: "String" = "String"

Const SlotDifferenceCollection

SlotDifferenceCollection: object
interface

Collection of slot differences.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SlotDifferenceCollection"

__@iterator

  • __@iterator(): IterableIterator<SlotDifference>
  • Iterator

    Returns IterableIterator<SlotDifference>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SlotDifference>[]): SlotDifference[]
  • concat(...items: (T | ConcatArray<T>)[]): SlotDifference[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SlotDifference>[]

      Additional items to add to the end of array1.

    Returns SlotDifference[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SlotDifference[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SlotDifference]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SlotDifference]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SlotDifference, index: number, array: SlotDifference[]): boolean
        • Parameters

          • value: SlotDifference
          • index: number
          • array: SlotDifference[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SlotDifference, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SlotDifference

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SlotDifference[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SlotDifference

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SlotDifference, index: number, array: SlotDifference[]): boolean
        • Parameters

          • value: SlotDifference
          • index: number
          • array: SlotDifference[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SlotDifference, index: number, array: SlotDifference[]): any
        • Parameters

          • value: SlotDifference
          • index: number
          • array: SlotDifference[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SlotDifference[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SlotDifference | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SlotDifference

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SlotDifference, index: number, obj: SlotDifference[]): boolean
        • Parameters

          • this: void
          • value: SlotDifference
          • index: number
          • obj: SlotDifference[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SlotDifference, index: number, obj: SlotDifference[]): boolean
        • Parameters

          • value: SlotDifference
          • index: number
          • obj: SlotDifference[]

          Returns boolean

    • Optional thisArg: any

    Returns SlotDifference | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SlotDifference, index: number, obj: SlotDifference[]): boolean
        • Parameters

          • value: SlotDifference
          • index: number
          • obj: SlotDifference[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SlotDifference, index: number, array: SlotDifference[]): void
        • Parameters

          • value: SlotDifference
          • index: number
          • array: SlotDifference[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SlotDifference, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SlotDifference

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SlotDifference, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SlotDifference

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SlotDifference, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SlotDifference

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SlotDifference, index: number, array: SlotDifference[]): U
        • Parameters

          • value: SlotDifference
          • index: number
          • array: SlotDifference[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SlotDifference | undefined
  • Removes the last element from an array and returns it.

    Returns SlotDifference | undefined

push

  • push(...items: SlotDifference[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SlotDifference[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SlotDifference
  • reduce(callbackfn: function, initialValue: SlotDifference): SlotDifference
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SlotDifference, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): SlotDifference
        • Parameters

          • previousValue: SlotDifference
          • currentValue: SlotDifference
          • currentIndex: number
          • array: SlotDifference[]

          Returns SlotDifference

    Returns SlotDifference

  • Parameters

    • callbackfn: function
        • (previousValue: SlotDifference, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): SlotDifference
        • Parameters

          • previousValue: SlotDifference
          • currentValue: SlotDifference
          • currentIndex: number
          • array: SlotDifference[]

          Returns SlotDifference

    • initialValue: SlotDifference

    Returns SlotDifference

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): U
        • Parameters

          • previousValue: U
          • currentValue: SlotDifference
          • currentIndex: number
          • array: SlotDifference[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SlotDifference
  • reduceRight(callbackfn: function, initialValue: SlotDifference): SlotDifference
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SlotDifference, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): SlotDifference
        • Parameters

          • previousValue: SlotDifference
          • currentValue: SlotDifference
          • currentIndex: number
          • array: SlotDifference[]

          Returns SlotDifference

    Returns SlotDifference

  • Parameters

    • callbackfn: function
        • (previousValue: SlotDifference, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): SlotDifference
        • Parameters

          • previousValue: SlotDifference
          • currentValue: SlotDifference
          • currentIndex: number
          • array: SlotDifference[]

          Returns SlotDifference

    • initialValue: SlotDifference

    Returns SlotDifference

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): U
        • Parameters

          • previousValue: U
          • currentValue: SlotDifference
          • currentIndex: number
          • array: SlotDifference[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SlotDifference[]
  • Reverses the elements in an Array.

    Returns SlotDifference[]

shift

  • shift(): SlotDifference | undefined
  • Removes the first element from an array and returns it.

    Returns SlotDifference | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SlotDifference[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SlotDifference[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SlotDifference, index: number, array: SlotDifference[]): boolean
        • Parameters

          • value: SlotDifference
          • index: number
          • array: SlotDifference[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SlotDifference[]
  • splice(start: number, deleteCount: number, ...items: SlotDifference[]): SlotDifference[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SlotDifference[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SlotDifference[]

      Elements to insert into the array in place of the deleted elements.

    Returns SlotDifference[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SlotDifference[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SlotDifference[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SlotDifference>
  • Returns an iterable of values in the array

    Returns IterableIterator<SlotDifference>

type

type: object

className

className: string = "SlotDifferenceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SlotDifference"

name

name: "Composite" = "Composite"

Const SlotSwapStatus

SlotSwapStatus: object

The status of the last successful slot swap operation.

Optional destinationSlotName

destinationSlotName: undefined | string

The destination slot of the last swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SlotSwapStatus"

Optional sourceSlotName

sourceSlotName: undefined | string

The source slot of the last swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timestampUtc

timestampUtc: Date

The time the last successful slot swap completed. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SlotSwapStatus"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

destinationSlotName

destinationSlotName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "destinationSlotName"

type

type: object

name

name: "String" = "String"

sourceSlotName

sourceSlotName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "sourceSlotName"

type

type: object

name

name: "String" = "String"

timestampUtc

timestampUtc: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "timestampUtc"

type

type: object

name

name: "DateTime" = "DateTime"

Const SlowRequestsBasedTrigger

SlowRequestsBasedTrigger: object

Trigger based on request execution time.

Optional count

count: undefined | number

Request Count.

serializedName

serializedName: string = "SlowRequestsBasedTrigger"

Optional timeInterval

timeInterval: undefined | string

Time interval.

Optional timeTaken

timeTaken: undefined | string

Time taken.

type

type: object

className

className: string = "SlowRequestsBasedTrigger"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

timeInterval

timeInterval: object

serializedName

serializedName: string = "timeInterval"

type

type: object

name

name: "String" = "String"

timeTaken

timeTaken: object

serializedName

serializedName: string = "timeTaken"

type

type: object

name

name: "String" = "String"

Const Snapshot

Snapshot: object

A snapshot of an app.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Snapshot"

Optional time

time: undefined | string

The time the snapshot was taken. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Snapshot"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

time

time: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.time"

type

type: object

name

name: "String" = "String"

Const SnapshotCollection

SnapshotCollection: object
interface

Collection of snapshots which can be used to revert an app to a previous time.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SnapshotCollection"

__@iterator

  • __@iterator(): IterableIterator<Snapshot>
  • Iterator

    Returns IterableIterator<Snapshot>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Snapshot>[]): Snapshot[]
  • concat(...items: (T | ConcatArray<T>)[]): Snapshot[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Snapshot>[]

      Additional items to add to the end of array1.

    Returns Snapshot[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Snapshot[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Snapshot]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Snapshot]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Snapshot, index: number, array: Snapshot[]): boolean
        • Parameters

          • value: Snapshot
          • index: number
          • array: Snapshot[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Snapshot, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Snapshot

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Snapshot[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Snapshot

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Snapshot, index: number, array: Snapshot[]): boolean
        • Parameters

          • value: Snapshot
          • index: number
          • array: Snapshot[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Snapshot, index: number, array: Snapshot[]): any
        • Parameters

          • value: Snapshot
          • index: number
          • array: Snapshot[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Snapshot[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Snapshot | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Snapshot

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Snapshot, index: number, obj: Snapshot[]): boolean
        • Parameters

          • this: void
          • value: Snapshot
          • index: number
          • obj: Snapshot[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Snapshot, index: number, obj: Snapshot[]): boolean
        • Parameters

          • value: Snapshot
          • index: number
          • obj: Snapshot[]

          Returns boolean

    • Optional thisArg: any

    Returns Snapshot | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Snapshot, index: number, obj: Snapshot[]): boolean
        • Parameters

          • value: Snapshot
          • index: number
          • obj: Snapshot[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Snapshot, index: number, array: Snapshot[]): void
        • Parameters

          • value: Snapshot
          • index: number
          • array: Snapshot[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Snapshot, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Snapshot

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Snapshot, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Snapshot

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Snapshot, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Snapshot

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Snapshot, index: number, array: Snapshot[]): U
        • Parameters

          • value: Snapshot
          • index: number
          • array: Snapshot[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Snapshot | undefined
  • Removes the last element from an array and returns it.

    Returns Snapshot | undefined

push

  • push(...items: Snapshot[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Snapshot[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Snapshot
  • reduce(callbackfn: function, initialValue: Snapshot): Snapshot
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Snapshot, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): Snapshot
        • Parameters

          • previousValue: Snapshot
          • currentValue: Snapshot
          • currentIndex: number
          • array: Snapshot[]

          Returns Snapshot

    Returns Snapshot

  • Parameters

    • callbackfn: function
        • (previousValue: Snapshot, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): Snapshot
        • Parameters

          • previousValue: Snapshot
          • currentValue: Snapshot
          • currentIndex: number
          • array: Snapshot[]

          Returns Snapshot

    • initialValue: Snapshot

    Returns Snapshot

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): U
        • Parameters

          • previousValue: U
          • currentValue: Snapshot
          • currentIndex: number
          • array: Snapshot[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Snapshot
  • reduceRight(callbackfn: function, initialValue: Snapshot): Snapshot
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Snapshot, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): Snapshot
        • Parameters

          • previousValue: Snapshot
          • currentValue: Snapshot
          • currentIndex: number
          • array: Snapshot[]

          Returns Snapshot

    Returns Snapshot

  • Parameters

    • callbackfn: function
        • (previousValue: Snapshot, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): Snapshot
        • Parameters

          • previousValue: Snapshot
          • currentValue: Snapshot
          • currentIndex: number
          • array: Snapshot[]

          Returns Snapshot

    • initialValue: Snapshot

    Returns Snapshot

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): U
        • Parameters

          • previousValue: U
          • currentValue: Snapshot
          • currentIndex: number
          • array: Snapshot[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Snapshot[]
  • Reverses the elements in an Array.

    Returns Snapshot[]

shift

  • shift(): Snapshot | undefined
  • Removes the first element from an array and returns it.

    Returns Snapshot | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Snapshot[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Snapshot[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Snapshot, index: number, array: Snapshot[]): boolean
        • Parameters

          • value: Snapshot
          • index: number
          • array: Snapshot[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Snapshot[]
  • splice(start: number, deleteCount: number, ...items: Snapshot[]): Snapshot[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Snapshot[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Snapshot[]

      Elements to insert into the array in place of the deleted elements.

    Returns Snapshot[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Snapshot[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Snapshot[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Snapshot>
  • Returns an iterable of values in the array

    Returns IterableIterator<Snapshot>

type

type: object

className

className: string = "SnapshotCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Snapshot"

name

name: "Composite" = "Composite"

Const SnapshotRecoverySource

SnapshotRecoverySource: object

Specifies the web app that snapshot contents will be retrieved from.

Optional id

id: undefined | string

ARM resource ID of the source app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.

Optional location

location: undefined | string

Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS

serializedName

serializedName: string = "SnapshotRecoverySource"

type

type: object

className

className: string = "SnapshotRecoverySource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const SnapshotRestoreRequest

SnapshotRestoreRequest: object

Details about app recovery operation.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ignoreConflictingHostNames

ignoreConflictingHostNames: undefined | false | true

If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

overwrite

overwrite: boolean

If true the restore operation can overwrite source app; otherwise, false.

Optional recoverConfiguration

recoverConfiguration: undefined | false | true

If true, site configuration, in addition to content, will be reverted.

Optional recoverySource

recoverySource: SnapshotRecoverySource

Optional. Specifies the web app that snapshot contents will be retrieved from. If empty, the targeted web app will be used as the source.

serializedName

serializedName: string = "SnapshotRestoreRequest"

Optional snapshotTime

snapshotTime: undefined | string

Point in time in which the app restore should be done, formatted as a DateTime string.

Optional useDRSecondary

useDRSecondary: undefined | false | true

If true, the snapshot is retrieved from DRSecondary endpoint.

type

type: object

className

className: string = "SnapshotRestoreRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ignoreConflictingHostNames

ignoreConflictingHostNames: object

serializedName

serializedName: string = "properties.ignoreConflictingHostNames"

type

type: object

name

name: "Boolean" = "Boolean"

overwrite

overwrite: object

required

required: true = true

serializedName

serializedName: string = "properties.overwrite"

type

type: object

name

name: "Boolean" = "Boolean"

recoverConfiguration

recoverConfiguration: object

serializedName

serializedName: string = "properties.recoverConfiguration"

type

type: object

name

name: "Boolean" = "Boolean"

recoverySource

recoverySource: object

serializedName

serializedName: string = "properties.recoverySource"

type

type: object

className

className: string = "SnapshotRecoverySource"

name

name: "Composite" = "Composite"

snapshotTime

snapshotTime: object

serializedName

serializedName: string = "properties.snapshotTime"

type

type: object

name

name: "String" = "String"

useDRSecondary

useDRSecondary: object

serializedName

serializedName: string = "properties.useDRSecondary"

type

type: object

name

name: "Boolean" = "Boolean"

Const SourceControl

SourceControl: object

The source control OAuth token.

Optional expirationTime

expirationTime: Date

OAuth token expiration.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional refreshToken

refreshToken: undefined | string

OAuth refresh token.

serializedName

serializedName: string = "SourceControl"

Optional token

token: undefined | string

OAuth access token.

Optional tokenSecret

tokenSecret: undefined | string

OAuth access token secret.

type

type: object

className

className: string = "SourceControl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

expirationTime

expirationTime: object

serializedName

serializedName: string = "properties.expirationTime"

type

type: object

name

name: "DateTime" = "DateTime"

refreshToken

refreshToken: object

serializedName

serializedName: string = "properties.refreshToken"

type

type: object

name

name: "String" = "String"

token

token: object

serializedName

serializedName: string = "properties.token"

type

type: object

name

name: "String" = "String"

tokenSecret

tokenSecret: object

serializedName

serializedName: string = "properties.tokenSecret"

type

type: object

name

name: "String" = "String"

Const SourceControlCollection

SourceControlCollection: object
interface

Collection of source controls.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SourceControlCollection"

__@iterator

  • __@iterator(): IterableIterator<SourceControl>
  • Iterator

    Returns IterableIterator<SourceControl>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SourceControl>[]): SourceControl[]
  • concat(...items: (T | ConcatArray<T>)[]): SourceControl[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SourceControl>[]

      Additional items to add to the end of array1.

    Returns SourceControl[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SourceControl[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SourceControl]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SourceControl]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SourceControl, index: number, array: SourceControl[]): boolean
        • Parameters

          • value: SourceControl
          • index: number
          • array: SourceControl[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SourceControl, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SourceControl

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SourceControl[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SourceControl

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SourceControl, index: number, array: SourceControl[]): boolean
        • Parameters

          • value: SourceControl
          • index: number
          • array: SourceControl[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SourceControl, index: number, array: SourceControl[]): any
        • Parameters

          • value: SourceControl
          • index: number
          • array: SourceControl[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SourceControl[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SourceControl | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SourceControl

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SourceControl, index: number, obj: SourceControl[]): boolean
        • Parameters

          • this: void
          • value: SourceControl
          • index: number
          • obj: SourceControl[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SourceControl, index: number, obj: SourceControl[]): boolean
        • Parameters

          • value: SourceControl
          • index: number
          • obj: SourceControl[]

          Returns boolean

    • Optional thisArg: any

    Returns SourceControl | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SourceControl, index: number, obj: SourceControl[]): boolean
        • Parameters

          • value: SourceControl
          • index: number
          • obj: SourceControl[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SourceControl, index: number, array: SourceControl[]): void
        • Parameters

          • value: SourceControl
          • index: number
          • array: SourceControl[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SourceControl, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SourceControl

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SourceControl, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SourceControl

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SourceControl, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SourceControl

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SourceControl, index: number, array: SourceControl[]): U
        • Parameters

          • value: SourceControl
          • index: number
          • array: SourceControl[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SourceControl | undefined
  • Removes the last element from an array and returns it.

    Returns SourceControl | undefined

push

  • push(...items: SourceControl[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SourceControl[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SourceControl
  • reduce(callbackfn: function, initialValue: SourceControl): SourceControl
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SourceControl, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): SourceControl
        • Parameters

          • previousValue: SourceControl
          • currentValue: SourceControl
          • currentIndex: number
          • array: SourceControl[]

          Returns SourceControl

    Returns SourceControl

  • Parameters

    • callbackfn: function
        • (previousValue: SourceControl, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): SourceControl
        • Parameters

          • previousValue: SourceControl
          • currentValue: SourceControl
          • currentIndex: number
          • array: SourceControl[]

          Returns SourceControl

    • initialValue: SourceControl

    Returns SourceControl

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): U
        • Parameters

          • previousValue: U
          • currentValue: SourceControl
          • currentIndex: number
          • array: SourceControl[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SourceControl
  • reduceRight(callbackfn: function, initialValue: SourceControl): SourceControl
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SourceControl, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): SourceControl
        • Parameters

          • previousValue: SourceControl
          • currentValue: SourceControl
          • currentIndex: number
          • array: SourceControl[]

          Returns SourceControl

    Returns SourceControl

  • Parameters

    • callbackfn: function
        • (previousValue: SourceControl, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): SourceControl
        • Parameters

          • previousValue: SourceControl
          • currentValue: SourceControl
          • currentIndex: number
          • array: SourceControl[]

          Returns SourceControl

    • initialValue: SourceControl

    Returns SourceControl

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): U
        • Parameters

          • previousValue: U
          • currentValue: SourceControl
          • currentIndex: number
          • array: SourceControl[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SourceControl[]
  • Reverses the elements in an Array.

    Returns SourceControl[]

shift

  • shift(): SourceControl | undefined
  • Removes the first element from an array and returns it.

    Returns SourceControl | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SourceControl[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SourceControl[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SourceControl, index: number, array: SourceControl[]): boolean
        • Parameters

          • value: SourceControl
          • index: number
          • array: SourceControl[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SourceControl[]
  • splice(start: number, deleteCount: number, ...items: SourceControl[]): SourceControl[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SourceControl[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SourceControl[]

      Elements to insert into the array in place of the deleted elements.

    Returns SourceControl[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SourceControl[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SourceControl[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SourceControl>
  • Returns an iterable of values in the array

    Returns IterableIterator<SourceControl>

type

type: object

className

className: string = "SourceControlCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SourceControl"

name

name: "Composite" = "Composite"

Const StackMajorVersion

StackMajorVersion: object

Application stack major version.

Optional applicationInsights

applicationInsights: undefined | false | true

true if this supports Application Insights; otherwise, false.

Optional displayVersion

displayVersion: undefined | string

Application stack major version (display only).

Optional isDefault

isDefault: undefined | false | true

true if this is the default major version; otherwise, false.

Optional minorVersions

minorVersions: StackMinorVersion[]

Minor versions associated with the major version.

Optional runtimeVersion

runtimeVersion: undefined | string

Application stack major version (runtime only).

serializedName

serializedName: string = "StackMajorVersion"

type

type: object

className

className: string = "StackMajorVersion"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationInsights

applicationInsights: object

serializedName

serializedName: string = "applicationInsights"

type

type: object

name

name: "Boolean" = "Boolean"

displayVersion

displayVersion: object

serializedName

serializedName: string = "displayVersion"

type

type: object

name

name: "String" = "String"

isDefault

isDefault: object

serializedName

serializedName: string = "isDefault"

type

type: object

name

name: "Boolean" = "Boolean"

minorVersions

minorVersions: object

serializedName

serializedName: string = "minorVersions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "StackMinorVersion"

name

name: "Composite" = "Composite"

runtimeVersion

runtimeVersion: object

serializedName

serializedName: string = "runtimeVersion"

type

type: object

name

name: "String" = "String"

Const StackMinorVersion

StackMinorVersion: object

Application stack minor version.

Optional displayVersion

displayVersion: undefined | string

Application stack minor version (display only).

Optional isDefault

isDefault: undefined | false | true

true if this is the default minor version; otherwise, false.

Optional isRemoteDebuggingEnabled

isRemoteDebuggingEnabled: undefined | false | true

true if this supports Remote Debugging, otherwise false.

Optional runtimeVersion

runtimeVersion: undefined | string

Application stack minor version (runtime only).

serializedName

serializedName: string = "StackMinorVersion"

type

type: object

className

className: string = "StackMinorVersion"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

displayVersion

displayVersion: object

serializedName

serializedName: string = "displayVersion"

type

type: object

name

name: "String" = "String"

isDefault

isDefault: object

serializedName

serializedName: string = "isDefault"

type

type: object

name

name: "Boolean" = "Boolean"

isRemoteDebuggingEnabled

isRemoteDebuggingEnabled: object

serializedName

serializedName: string = "isRemoteDebuggingEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

runtimeVersion

runtimeVersion: object

serializedName

serializedName: string = "runtimeVersion"

type

type: object

name

name: "String" = "String"

Const StampCapacity

StampCapacity: object

Stamp capacity information.

Optional availableCapacity

availableCapacity: undefined | number

Available capacity (# of machines, bytes of storage etc...).

Optional computeMode

computeMode: ComputeModeOptions

Shared/dedicated workers. Possible values include: 'Shared', 'Dedicated', 'Dynamic'

Optional excludeFromCapacityAllocation

excludeFromCapacityAllocation: undefined | false | true

If true, it includes basic apps. Basic apps are not used for capacity allocation.

Optional isApplicableForAllComputeModes

isApplicableForAllComputeModes: undefined | false | true

true if capacity is applicable for all apps; otherwise, false.

Optional isLinux

isLinux: undefined | false | true

Is this a linux stamp capacity

Optional name

name: undefined | string

Name of the stamp.

serializedName

serializedName: string = "StampCapacity"

Optional siteMode

siteMode: undefined | string

Shared or Dedicated.

Optional totalCapacity

totalCapacity: undefined | number

Total capacity (# of machines, bytes of storage etc...).

Optional unit

unit: undefined | string

Name of the unit.

Optional workerSize

workerSize: WorkerSizeOptions

Size of the machines. Possible values include: 'Small', 'Medium', 'Large', 'D1', 'D2', 'D3', 'Default'

Optional workerSizeId

workerSizeId: undefined | number

Size ID of machines: 0 - Small 1 - Medium 2 - Large

type

type: object

className

className: string = "StampCapacity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

availableCapacity

availableCapacity: object

serializedName

serializedName: string = "availableCapacity"

type

type: object

name

name: "Number" = "Number"

computeMode

computeMode: object

serializedName

serializedName: string = "computeMode"

type

type: object

allowedValues

allowedValues: string[] = ["Shared","Dedicated","Dynamic"]

name

name: "Enum" = "Enum"

excludeFromCapacityAllocation

excludeFromCapacityAllocation: object

serializedName

serializedName: string = "excludeFromCapacityAllocation"

type

type: object

name

name: "Boolean" = "Boolean"

isApplicableForAllComputeModes

isApplicableForAllComputeModes: object

serializedName

serializedName: string = "isApplicableForAllComputeModes"

type

type: object

name

name: "Boolean" = "Boolean"

isLinux

isLinux: object

serializedName

serializedName: string = "isLinux"

type

type: object

name

name: "Boolean" = "Boolean"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

siteMode

siteMode: object

serializedName

serializedName: string = "siteMode"

type

type: object

name

name: "String" = "String"

totalCapacity

totalCapacity: object

serializedName

serializedName: string = "totalCapacity"

type

type: object

name

name: "Number" = "Number"

unit

unit: object

serializedName

serializedName: string = "unit"

type

type: object

name

name: "String" = "String"

workerSize

workerSize: object

serializedName

serializedName: string = "workerSize"

type

type: object

allowedValues

allowedValues: string[] = ["Small","Medium","Large","D1","D2","D3","Default"]

name

name: "Enum" = "Enum"

workerSizeId

workerSizeId: object

serializedName

serializedName: string = "workerSizeId"

type

type: object

name

name: "Number" = "Number"

Const StatusCodesBasedTrigger

StatusCodesBasedTrigger: object

Trigger based on status code.

Optional count

count: undefined | number

Request Count.

serializedName

serializedName: string = "StatusCodesBasedTrigger"

Optional status

status: undefined | number

HTTP status code.

Optional subStatus

subStatus: undefined | number

Request Sub Status.

Optional timeInterval

timeInterval: undefined | string

Time interval.

Optional win32Status

win32Status: undefined | number

Win32 error code.

type

type: object

className

className: string = "StatusCodesBasedTrigger"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

count

count: object

serializedName

serializedName: string = "count"

type

type: object

name

name: "Number" = "Number"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "Number" = "Number"

subStatus

subStatus: object

serializedName

serializedName: string = "subStatus"

type

type: object

name

name: "Number" = "Number"

timeInterval

timeInterval: object

serializedName

serializedName: string = "timeInterval"

type

type: object

name

name: "String" = "String"

win32Status

win32Status: object

serializedName

serializedName: string = "win32Status"

type

type: object

name

name: "Number" = "Number"

Const StorageMigrationOptions

StorageMigrationOptions: object

Options for app content migration.

azurefilesConnectionString

azurefilesConnectionString: string

AzureFiles connection string.

azurefilesShare

azurefilesShare: string

AzureFiles share.

Optional blockWriteAccessToSite

blockWriteAccessToSite: undefined | false | true

true if the app should be read only during copy operation; otherwise, false. Default value: false.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "StorageMigrationOptions"

Optional switchSiteAfterMigration

switchSiteAfterMigration: undefined | false | true

trueif the app should be switched over; otherwise, false. Default value: false.

type

type: object

className

className: string = "StorageMigrationOptions"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

azurefilesConnectionString

azurefilesConnectionString: object

required

required: true = true

serializedName

serializedName: string = "properties.azurefilesConnectionString"

type

type: object

name

name: "String" = "String"

azurefilesShare

azurefilesShare: object

required

required: true = true

serializedName

serializedName: string = "properties.azurefilesShare"

type

type: object

name

name: "String" = "String"

blockWriteAccessToSite

blockWriteAccessToSite: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.blockWriteAccessToSite"

type

type: object

name

name: "Boolean" = "Boolean"

switchSiteAfterMigration

switchSiteAfterMigration: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.switchSiteAfterMigration"

type

type: object

name

name: "Boolean" = "Boolean"

Const StorageMigrationResponse

StorageMigrationResponse: object

Response for a migration of app content request.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationId

operationId: undefined | string

When server starts the migration process, it will return an operation ID identifying that particular migration operation. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "StorageMigrationResponse"

type

type: object

className

className: string = "StorageMigrationResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operationId

operationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operationId"

type

type: object

name

name: "String" = "String"

Const StringDictionary

StringDictionary: object

String dictionary resource.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

Settings.

serializedName

serializedName: string = "StringDictionary"

type

type: object

className

className: string = "StringDictionary"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

Const SwiftVirtualNetwork

SwiftVirtualNetwork: object

Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SwiftVirtualNetwork"

Optional subnetResourceId

subnetResourceId: undefined | string

The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.

Optional swiftSupported

swiftSupported: undefined | false | true

A flag that specifies if the scale unit this Web App is on supports Swift integration.

type

type: object

className

className: string = "SwiftVirtualNetwork"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

subnetResourceId

subnetResourceId: object

serializedName

serializedName: string = "properties.subnetResourceId"

type

type: object

name

name: "String" = "String"

swiftSupported

swiftSupported: object

serializedName

serializedName: string = "properties.swiftSupported"

type

type: object

name

name: "Boolean" = "Boolean"

Const TriggeredJobHistory

TriggeredJobHistory: object

Triggered Web Job History. List of Triggered Web Job Run Information elements.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runs

runs: TriggeredJobRun[]

List of triggered web job runs.

serializedName

serializedName: string = "TriggeredJobHistory"

type

type: object

className

className: string = "TriggeredJobHistory"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

runs

runs: object

serializedName

serializedName: string = "properties.runs"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TriggeredJobRun"

name

name: "Composite" = "Composite"

Const TriggeredJobHistoryCollection

TriggeredJobHistoryCollection: object
interface

Collection of Kudu continuous web job information elements.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TriggeredJobHistoryCollection"

__@iterator

  • __@iterator(): IterableIterator<TriggeredJobHistory>
  • Iterator

    Returns IterableIterator<TriggeredJobHistory>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<TriggeredJobHistory>[]): TriggeredJobHistory[]
  • concat(...items: (T | ConcatArray<T>)[]): TriggeredJobHistory[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<TriggeredJobHistory>[]

      Additional items to add to the end of array1.

    Returns TriggeredJobHistory[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns TriggeredJobHistory[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, TriggeredJobHistory]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, TriggeredJobHistory]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): boolean
        • Parameters

          • value: TriggeredJobHistory
          • index: number
          • array: TriggeredJobHistory[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: TriggeredJobHistory, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: TriggeredJobHistory

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): TriggeredJobHistory[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: TriggeredJobHistory

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): boolean
        • Parameters

          • value: TriggeredJobHistory
          • index: number
          • array: TriggeredJobHistory[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): any
        • Parameters

          • value: TriggeredJobHistory
          • index: number
          • array: TriggeredJobHistory[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns TriggeredJobHistory[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): TriggeredJobHistory | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: TriggeredJobHistory

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: TriggeredJobHistory, index: number, obj: TriggeredJobHistory[]): boolean
        • Parameters

          • this: void
          • value: TriggeredJobHistory
          • index: number
          • obj: TriggeredJobHistory[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: TriggeredJobHistory, index: number, obj: TriggeredJobHistory[]): boolean
        • Parameters

          • value: TriggeredJobHistory
          • index: number
          • obj: TriggeredJobHistory[]

          Returns boolean

    • Optional thisArg: any

    Returns TriggeredJobHistory | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: TriggeredJobHistory, index: number, obj: TriggeredJobHistory[]): boolean
        • Parameters

          • value: TriggeredJobHistory
          • index: number
          • obj: TriggeredJobHistory[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): void
        • Parameters

          • value: TriggeredJobHistory
          • index: number
          • array: TriggeredJobHistory[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: TriggeredJobHistory, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: TriggeredJobHistory

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: TriggeredJobHistory, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: TriggeredJobHistory

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: TriggeredJobHistory, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: TriggeredJobHistory

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): U
        • Parameters

          • value: TriggeredJobHistory
          • index: number
          • array: TriggeredJobHistory[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): TriggeredJobHistory | undefined
  • Removes the last element from an array and returns it.

    Returns TriggeredJobHistory | undefined

push

  • push(...items: TriggeredJobHistory[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: TriggeredJobHistory[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): TriggeredJobHistory
  • reduce(callbackfn: function, initialValue: TriggeredJobHistory): TriggeredJobHistory
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: TriggeredJobHistory, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): TriggeredJobHistory
        • Parameters

          • previousValue: TriggeredJobHistory
          • currentValue: TriggeredJobHistory
          • currentIndex: number
          • array: TriggeredJobHistory[]

          Returns TriggeredJobHistory

    Returns TriggeredJobHistory

  • Parameters

    • callbackfn: function
        • (previousValue: TriggeredJobHistory, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): TriggeredJobHistory
        • Parameters

          • previousValue: TriggeredJobHistory
          • currentValue: TriggeredJobHistory
          • currentIndex: number
          • array: TriggeredJobHistory[]

          Returns TriggeredJobHistory

    • initialValue: TriggeredJobHistory

    Returns TriggeredJobHistory

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): U
        • Parameters

          • previousValue: U
          • currentValue: TriggeredJobHistory
          • currentIndex: number
          • array: TriggeredJobHistory[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): TriggeredJobHistory
  • reduceRight(callbackfn: function, initialValue: TriggeredJobHistory): TriggeredJobHistory
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: TriggeredJobHistory, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): TriggeredJobHistory
        • Parameters

          • previousValue: TriggeredJobHistory
          • currentValue: TriggeredJobHistory
          • currentIndex: number
          • array: TriggeredJobHistory[]

          Returns TriggeredJobHistory

    Returns TriggeredJobHistory

  • Parameters

    • callbackfn: function
        • (previousValue: TriggeredJobHistory, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): TriggeredJobHistory
        • Parameters

          • previousValue: TriggeredJobHistory
          • currentValue: TriggeredJobHistory
          • currentIndex: number
          • array: TriggeredJobHistory[]

          Returns TriggeredJobHistory

    • initialValue: TriggeredJobHistory

    Returns TriggeredJobHistory

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): U
        • Parameters

          • previousValue: U
          • currentValue: TriggeredJobHistory
          • currentIndex: number
          • array: TriggeredJobHistory[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): TriggeredJobHistory[]
  • Reverses the elements in an Array.

    Returns TriggeredJobHistory[]

shift

  • shift(): TriggeredJobHistory | undefined
  • Removes the first element from an array and returns it.

    Returns TriggeredJobHistory | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): TriggeredJobHistory[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns TriggeredJobHistory[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): boolean
        • Parameters

          • value: TriggeredJobHistory
          • index: number
          • array: TriggeredJobHistory[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): TriggeredJobHistory[]
  • splice(start: number, deleteCount: number, ...items: TriggeredJobHistory[]): TriggeredJobHistory[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns TriggeredJobHistory[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: TriggeredJobHistory[]

      Elements to insert into the array in place of the deleted elements.

    Returns TriggeredJobHistory[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: TriggeredJobHistory[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: TriggeredJobHistory[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<TriggeredJobHistory>
  • Returns an iterable of values in the array

    Returns IterableIterator<TriggeredJobHistory>

type

type: object

className

className: string = "TriggeredJobHistoryCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TriggeredJobHistory"

name

name: "Composite" = "Composite"

Const TriggeredJobRun

TriggeredJobRun: object

Triggered Web Job Run Information.

Optional duration

duration: undefined | string

Job duration.

Optional endTime

endTime: Date

End time.

Optional errorUrl

errorUrl: undefined | string

Error URL.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobName

jobName: undefined | string

Job name.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputUrl

outputUrl: undefined | string

Output URL.

serializedName

serializedName: string = "TriggeredJobRun"

Optional startTime

startTime: Date

Start time.

Optional status

Job status. Possible values include: 'Success', 'Failed', 'Error'

Optional trigger

trigger: undefined | string

Job trigger.

Optional url

url: undefined | string

Job URL.

Optional webJobId

webJobId: undefined | string

Job ID.

Optional webJobName

webJobName: undefined | string

Job name.

type

type: object

className

className: string = "TriggeredJobRun"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

duration

duration: object

serializedName

serializedName: string = "properties.duration"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "properties.end_time"

type

type: object

name

name: "DateTime" = "DateTime"

errorUrl

errorUrl: object

serializedName

serializedName: string = "properties.error_url"

type

type: object

name

name: "String" = "String"

jobName

jobName: object

serializedName

serializedName: string = "properties.job_name"

type

type: object

name

name: "String" = "String"

outputUrl

outputUrl: object

serializedName

serializedName: string = "properties.output_url"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "properties.start_time"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["Success","Failed","Error"]

name

name: "Enum" = "Enum"

trigger

trigger: object

serializedName

serializedName: string = "properties.trigger"

type

type: object

name

name: "String" = "String"

url

url: object

serializedName

serializedName: string = "properties.url"

type

type: object

name

name: "String" = "String"

webJobId

webJobId: object

serializedName

serializedName: string = "properties.web_job_id"

type

type: object

name

name: "String" = "String"

webJobName

webJobName: object

serializedName

serializedName: string = "properties.web_job_name"

type

type: object

name

name: "String" = "String"

Const TriggeredWebJob

TriggeredWebJob: object

Triggered Web Job Information.

Optional error

error: undefined | string

Error information.

Optional extraInfoUrl

extraInfoUrl: undefined | string

Extra Info URL.

Optional historyUrl

historyUrl: undefined | string

History URL.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional latestRun

latestRun: TriggeredJobRun

Latest job run information.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runCommand

runCommand: undefined | string

Run command.

Optional schedulerLogsUrl

schedulerLogsUrl: undefined | string

Scheduler Logs URL.

serializedName

serializedName: string = "TriggeredWebJob"

Optional settings

settings: undefined | object

Job settings.

Optional url

url: undefined | string

Job URL.

Optional usingSdk

usingSdk: undefined | false | true

Using SDK?

Optional webJobType

webJobType: WebJobType

Job type. Possible values include: 'Continuous', 'Triggered'

type

type: object

className

className: string = "TriggeredWebJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "properties.error"

type

type: object

name

name: "String" = "String"

extraInfoUrl

extraInfoUrl: object

serializedName

serializedName: string = "properties.extra_info_url"

type

type: object

name

name: "String" = "String"

historyUrl

historyUrl: object

serializedName

serializedName: string = "properties.history_url"

type

type: object

name

name: "String" = "String"

latestRun

latestRun: object

serializedName

serializedName: string = "properties.latest_run"

type

type: object

className

className: string = "TriggeredJobRun"

name

name: "Composite" = "Composite"

runCommand

runCommand: object

serializedName

serializedName: string = "properties.run_command"

type

type: object

name

name: "String" = "String"

schedulerLogsUrl

schedulerLogsUrl: object

serializedName

serializedName: string = "properties.scheduler_logs_url"

type

type: object

name

name: "String" = "String"

settings

settings: object

serializedName

serializedName: string = "properties.settings"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

url

url: object

serializedName

serializedName: string = "properties.url"

type

type: object

name

name: "String" = "String"

usingSdk

usingSdk: object

serializedName

serializedName: string = "properties.using_sdk"

type

type: object

name

name: "Boolean" = "Boolean"

webJobType

webJobType: object

serializedName

serializedName: string = "properties.web_job_type"

type

type: object

allowedValues

allowedValues: string[] = ["Continuous","Triggered"]

name

name: "Enum" = "Enum"

Const TriggeredWebJobCollection

TriggeredWebJobCollection: object
interface

Collection of Kudu continuous web job information elements.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TriggeredWebJobCollection"

__@iterator

  • __@iterator(): IterableIterator<TriggeredWebJob>
  • Iterator

    Returns IterableIterator<TriggeredWebJob>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<TriggeredWebJob>[]): TriggeredWebJob[]
  • concat(...items: (T | ConcatArray<T>)[]): TriggeredWebJob[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<TriggeredWebJob>[]

      Additional items to add to the end of array1.

    Returns TriggeredWebJob[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns TriggeredWebJob[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, TriggeredWebJob]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, TriggeredWebJob]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): boolean
        • Parameters

          • value: TriggeredWebJob
          • index: number
          • array: TriggeredWebJob[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: TriggeredWebJob, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: TriggeredWebJob

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): TriggeredWebJob[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: TriggeredWebJob

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): boolean
        • Parameters

          • value: TriggeredWebJob
          • index: number
          • array: TriggeredWebJob[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): any
        • Parameters

          • value: TriggeredWebJob
          • index: number
          • array: TriggeredWebJob[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns TriggeredWebJob[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): TriggeredWebJob | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: TriggeredWebJob

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: TriggeredWebJob, index: number, obj: TriggeredWebJob[]): boolean
        • Parameters

          • this: void
          • value: TriggeredWebJob
          • index: number
          • obj: TriggeredWebJob[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: TriggeredWebJob, index: number, obj: TriggeredWebJob[]): boolean
        • Parameters

          • value: TriggeredWebJob
          • index: number
          • obj: TriggeredWebJob[]

          Returns boolean

    • Optional thisArg: any

    Returns TriggeredWebJob | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: TriggeredWebJob, index: number, obj: TriggeredWebJob[]): boolean
        • Parameters

          • value: TriggeredWebJob
          • index: number
          • obj: TriggeredWebJob[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): void
        • Parameters

          • value: TriggeredWebJob
          • index: number
          • array: TriggeredWebJob[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: TriggeredWebJob, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: TriggeredWebJob

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: TriggeredWebJob, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: TriggeredWebJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: TriggeredWebJob, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: TriggeredWebJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): U
        • Parameters

          • value: TriggeredWebJob
          • index: number
          • array: TriggeredWebJob[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): TriggeredWebJob | undefined
  • Removes the last element from an array and returns it.

    Returns TriggeredWebJob | undefined

push

  • push(...items: TriggeredWebJob[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: TriggeredWebJob[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): TriggeredWebJob
  • reduce(callbackfn: function, initialValue: TriggeredWebJob): TriggeredWebJob
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: TriggeredWebJob, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): TriggeredWebJob
        • Parameters

          • previousValue: TriggeredWebJob
          • currentValue: TriggeredWebJob
          • currentIndex: number
          • array: TriggeredWebJob[]

          Returns TriggeredWebJob

    Returns TriggeredWebJob

  • Parameters

    • callbackfn: function
        • (previousValue: TriggeredWebJob, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): TriggeredWebJob
        • Parameters

          • previousValue: TriggeredWebJob
          • currentValue: TriggeredWebJob
          • currentIndex: number
          • array: TriggeredWebJob[]

          Returns TriggeredWebJob

    • initialValue: TriggeredWebJob

    Returns TriggeredWebJob

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): U
        • Parameters

          • previousValue: U
          • currentValue: TriggeredWebJob
          • currentIndex: number
          • array: TriggeredWebJob[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): TriggeredWebJob
  • reduceRight(callbackfn: function, initialValue: TriggeredWebJob): TriggeredWebJob
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: TriggeredWebJob, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): TriggeredWebJob
        • Parameters

          • previousValue: TriggeredWebJob
          • currentValue: TriggeredWebJob
          • currentIndex: number
          • array: TriggeredWebJob[]

          Returns TriggeredWebJob

    Returns TriggeredWebJob

  • Parameters

    • callbackfn: function
        • (previousValue: TriggeredWebJob, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): TriggeredWebJob
        • Parameters

          • previousValue: TriggeredWebJob
          • currentValue: TriggeredWebJob
          • currentIndex: number
          • array: TriggeredWebJob[]

          Returns TriggeredWebJob

    • initialValue: TriggeredWebJob

    Returns TriggeredWebJob

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): U
        • Parameters

          • previousValue: U
          • currentValue: TriggeredWebJob
          • currentIndex: number
          • array: TriggeredWebJob[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): TriggeredWebJob[]
  • Reverses the elements in an Array.

    Returns TriggeredWebJob[]

shift

  • shift(): TriggeredWebJob | undefined
  • Removes the first element from an array and returns it.

    Returns TriggeredWebJob | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): TriggeredWebJob[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns TriggeredWebJob[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): boolean
        • Parameters

          • value: TriggeredWebJob
          • index: number
          • array: TriggeredWebJob[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): TriggeredWebJob[]
  • splice(start: number, deleteCount: number, ...items: TriggeredWebJob[]): TriggeredWebJob[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns TriggeredWebJob[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: TriggeredWebJob[]

      Elements to insert into the array in place of the deleted elements.

    Returns TriggeredWebJob[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: TriggeredWebJob[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: TriggeredWebJob[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<TriggeredWebJob>
  • Returns an iterable of values in the array

    Returns IterableIterator<TriggeredWebJob>

type

type: object

className

className: string = "TriggeredWebJobCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TriggeredWebJob"

name

name: "Composite" = "Composite"

Const User

User: object

User credentials used for publishing activity.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publishingPassword

publishingPassword: undefined | string

Password used for publishing.

Optional publishingPasswordHash

publishingPasswordHash: undefined | string

Password hash used for publishing.

Optional publishingPasswordHashSalt

publishingPasswordHashSalt: undefined | string

Password hash salt used for publishing.

publishingUserName

publishingUserName: string

Username used for publishing.

Optional scmUri

scmUri: undefined | string

Url of SCM site.

serializedName

serializedName: string = "User"

type

type: object

className

className: string = "User"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

publishingPassword

publishingPassword: object

serializedName

serializedName: string = "properties.publishingPassword"

type

type: object

name

name: "String" = "String"

publishingPasswordHash

publishingPasswordHash: object

serializedName

serializedName: string = "properties.publishingPasswordHash"

type

type: object

name

name: "String" = "String"

publishingPasswordHashSalt

publishingPasswordHashSalt: object

serializedName

serializedName: string = "properties.publishingPasswordHashSalt"

type

type: object

name

name: "String" = "String"

publishingUserName

publishingUserName: object

required

required: true = true

serializedName

serializedName: string = "properties.publishingUserName"

type

type: object

name

name: "String" = "String"

scmUri

scmUri: object

serializedName

serializedName: string = "properties.scmUri"

type

type: object

name

name: "String" = "String"

Const ValidateContainerSettingsRequest

ValidateContainerSettingsRequest: object

Container settings validation request context

Optional baseUrl

baseUrl: undefined | string

Base URL of the container registry

Optional password

password: undefined | string

Password for to access the container registry

Optional platform

platform: undefined | string

Platform (windows or linux)

Optional repository

repository: undefined | string

Repository name (image name)

serializedName

serializedName: string = "ValidateContainerSettingsRequest"

Optional tag

tag: undefined | string

Image tag

Optional username

username: undefined | string

Username for to access the container registry

type

type: object

className

className: string = "ValidateContainerSettingsRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

baseUrl

baseUrl: object

serializedName

serializedName: string = "baseUrl"

type

type: object

name

name: "String" = "String"

password

password: object

serializedName

serializedName: string = "password"

type

type: object

name

name: "String" = "String"

platform

platform: object

serializedName

serializedName: string = "platform"

type

type: object

name

name: "String" = "String"

repository

repository: object

serializedName

serializedName: string = "repository"

type

type: object

name

name: "String" = "String"

tag

tag: object

serializedName

serializedName: string = "tag"

type

type: object

name

name: "String" = "String"

username

username: object

serializedName

serializedName: string = "username"

type

type: object

name

name: "String" = "String"

Const ValidateRequest

ValidateRequest: object

Resource validation request content.

Optional capacity

capacity: undefined | number

Target capacity of the App Service plan (number of VMs).

Optional hostingEnvironment

hostingEnvironment: undefined | string

Name of App Service Environment where app or App Service plan should be created.

Optional isSpot

isSpot: undefined | false | true

true if App Service plan is for Spot instances; otherwise, false.

Optional isXenon

isXenon: undefined | false | true

true if App Service plan is running as a windows container

location

location: string

Expected location of the resource.

name

name: string

Resource name to verify.

Optional needLinuxWorkers

needLinuxWorkers: undefined | false | true

true if App Service plan is for Linux workers; otherwise, false.

serializedName

serializedName: string = "ValidateRequest"

Optional serverFarmId

serverFarmId: undefined | string

ARM resource ID of an App Service plan that would host the app.

Optional skuName

skuName: undefined | string

Name of the target SKU for the App Service plan.

type

type: object

Resource type used for verification. Possible values include: 'ServerFarm', 'Site'

className

className: string = "ValidateRequest"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

serializedName: string = "properties.capacity"

constraints

constraints: object

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

name: "Number" = "Number"

hostingEnvironment

hostingEnvironment: object

serializedName

serializedName: string = "properties.hostingEnvironment"

type

type: object

name

name: "String" = "String"

isSpot

isSpot: object

serializedName

serializedName: string = "properties.isSpot"

type

type: object

name

name: "Boolean" = "Boolean"

isXenon

isXenon: object

serializedName

serializedName: string = "properties.isXenon"

type

type: object

name

name: "Boolean" = "Boolean"

location

location: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

needLinuxWorkers

needLinuxWorkers: object

serializedName

serializedName: string = "properties.needLinuxWorkers"

type

type: object

name

name: "Boolean" = "Boolean"

serverFarmId

serverFarmId: object

serializedName

serializedName: string = "properties.serverFarmId"

type

type: object

name

name: "String" = "String"

skuName

skuName: object

serializedName

serializedName: string = "properties.skuName"

type

type: object

name

name: "String" = "String"

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ValidateResponse

ValidateResponse: object

Describes the result of resource validation.

Optional error

Error details for the case when validation fails.

serializedName

serializedName: string = "ValidateResponse"

Optional status

status: undefined | string

Result of validation.

type

type: object

className

className: string = "ValidateResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ValidateResponseError"

name

name: "Composite" = "Composite"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const ValidateResponseError

ValidateResponseError: object

Error details for when validation fails.

Optional code

code: undefined | string

Validation error code.

Optional message

message: undefined | string

Validation error message.

serializedName

serializedName: string = "ValidateResponseError"

type

type: object

className

className: string = "ValidateResponseError"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const VirtualApplication

VirtualApplication: object

Virtual application in an app.

Optional physicalPath

physicalPath: undefined | string

Physical path.

Optional preloadEnabled

preloadEnabled: undefined | false | true

true if preloading is enabled; otherwise, false.

serializedName

serializedName: string = "VirtualApplication"

Optional virtualDirectories

virtualDirectories: VirtualDirectory[]

Virtual directories for virtual application.

Optional virtualPath

virtualPath: undefined | string

Virtual path.

type

type: object

className

className: string = "VirtualApplication"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

physicalPath

physicalPath: object

serializedName

serializedName: string = "physicalPath"

type

type: object

name

name: "String" = "String"

preloadEnabled

preloadEnabled: object

serializedName

serializedName: string = "preloadEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

virtualDirectories

virtualDirectories: object

serializedName

serializedName: string = "virtualDirectories"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VirtualDirectory"

name

name: "Composite" = "Composite"

virtualPath

virtualPath: object

serializedName

serializedName: string = "virtualPath"

type

type: object

name

name: "String" = "String"

Const VirtualDirectory

VirtualDirectory: object

Directory for virtual application.

Optional physicalPath

physicalPath: undefined | string

Physical path.

serializedName

serializedName: string = "VirtualDirectory"

Optional virtualPath

virtualPath: undefined | string

Path to virtual application.

type

type: object

className

className: string = "VirtualDirectory"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

physicalPath

physicalPath: object

serializedName

serializedName: string = "physicalPath"

type

type: object

name

name: "String" = "String"

virtualPath

virtualPath: object

serializedName

serializedName: string = "virtualPath"

type

type: object

name

name: "String" = "String"

Const VirtualIPMapping

VirtualIPMapping: object

Virtual IP mapping.

Optional inUse

inUse: undefined | false | true

Is virtual IP mapping in use.

Optional internalHttpPort

internalHttpPort: undefined | number

Internal HTTP port.

Optional internalHttpsPort

internalHttpsPort: undefined | number

Internal HTTPS port.

serializedName

serializedName: string = "VirtualIPMapping"

Optional virtualIP

virtualIP: undefined | string

Virtual IP address.

type

type: object

className

className: string = "VirtualIPMapping"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inUse

inUse: object

serializedName

serializedName: string = "inUse"

type

type: object

name

name: "Boolean" = "Boolean"

internalHttpPort

internalHttpPort: object

serializedName

serializedName: string = "internalHttpPort"

type

type: object

name

name: "Number" = "Number"

internalHttpsPort

internalHttpsPort: object

serializedName

serializedName: string = "internalHttpsPort"

type

type: object

name

name: "Number" = "Number"

virtualIP

virtualIP: object

serializedName

serializedName: string = "virtualIP"

type

type: object

name

name: "String" = "String"

Const VirtualNetworkProfile

VirtualNetworkProfile: object

Specification for using a Virtual Network.

Optional id

id: undefined | string

Resource id of the Virtual Network.

Optional name

name: undefined | string

Name of the Virtual Network (read-only). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkProfile"

Optional subnet

subnet: undefined | string

Subnet within the Virtual Network.

type

type: object

Resource type of the Virtual Network (read-only). NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "VirtualNetworkProfile"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

subnet

subnet: object

serializedName

serializedName: string = "subnet"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const VnetGateway

VnetGateway: object

The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetGateway"

Optional vnetName

vnetName: undefined | string

The Virtual Network name.

vpnPackageUri

vpnPackageUri: string

The URI where the VPN package can be downloaded.

type

type: object

className

className: string = "VnetGateway"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

vnetName

vnetName: object

serializedName

serializedName: string = "properties.vnetName"

type

type: object

name

name: "String" = "String"

vpnPackageUri

vpnPackageUri: object

required

required: true = true

serializedName

serializedName: string = "properties.vpnPackageUri"

type

type: object

name

name: "String" = "String"

Const VnetInfo

VnetInfo: object

Virtual Network information contract.

Optional certBlob

certBlob: undefined | string

A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.

Optional certThumbprint

certThumbprint: undefined | string

The client certificate thumbprint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsServers

dnsServers: undefined | string

DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isSwift

isSwift: undefined | false | true

Flag that is used to denote if this is VNET injection

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resyncRequired

resyncRequired: undefined | false | true

true if a resync is required; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional routes

routes: VnetRoute[]

The routes that this Virtual Network connection uses. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetInfo"

Optional vnetResourceId

vnetResourceId: undefined | string

The Virtual Network's resource ID.

type

type: object

className

className: string = "VnetInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

certBlob

certBlob: object

serializedName

serializedName: string = "properties.certBlob"

type

type: object

name

name: "String" = "String"

certThumbprint

certThumbprint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.certThumbprint"

type

type: object

name

name: "String" = "String"

dnsServers

dnsServers: object

serializedName

serializedName: string = "properties.dnsServers"

type

type: object

name

name: "String" = "String"

isSwift

isSwift: object

serializedName

serializedName: string = "properties.isSwift"

type

type: object

name

name: "Boolean" = "Boolean"

resyncRequired

resyncRequired: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resyncRequired"

type

type: object

name

name: "Boolean" = "Boolean"

routes

routes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.routes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VnetRoute"

name

name: "Composite" = "Composite"

vnetResourceId

vnetResourceId: object

serializedName

serializedName: string = "properties.vnetResourceId"

type

type: object

name

name: "String" = "String"

Const VnetParameters

VnetParameters: object

The required set of inputs to validate a VNET

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetParameters"

Optional vnetName

vnetName: undefined | string

The name of the VNET to be validated

Optional vnetResourceGroup

vnetResourceGroup: undefined | string

The Resource Group of the VNET to be validated

Optional vnetSubnetName

vnetSubnetName: undefined | string

The subnet name to be validated

type

type: object

className

className: string = "VnetParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

vnetName

vnetName: object

serializedName

serializedName: string = "properties.vnetName"

type

type: object

name

name: "String" = "String"

vnetResourceGroup

vnetResourceGroup: object

serializedName

serializedName: string = "properties.vnetResourceGroup"

type

type: object

name

name: "String" = "String"

vnetSubnetName

vnetSubnetName: object

serializedName

serializedName: string = "properties.vnetSubnetName"

type

type: object

name

name: "String" = "String"

Const VnetRoute

VnetRoute: object

Virtual Network route contract used to pass routing information for a Virtual Network.

Optional endAddress

endAddress: undefined | string

The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional routeType

routeType: RouteType

The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only

These values will be used for syncing an app's routes with those from a Virtual Network. Possible values include: 'DEFAULT', 'INHERITED', 'STATIC'

serializedName

serializedName: string = "VnetRoute"

Optional startAddress

startAddress: undefined | string

The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.

type

type: object

className

className: string = "VnetRoute"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endAddress

endAddress: object

serializedName

serializedName: string = "properties.endAddress"

type

type: object

name

name: "String" = "String"

routeType

routeType: object

serializedName

serializedName: string = "properties.routeType"

type

type: object

name

name: "String" = "String"

startAddress

startAddress: object

serializedName

serializedName: string = "properties.startAddress"

type

type: object

name

name: "String" = "String"

Const VnetValidationFailureDetails

VnetValidationFailureDetails: object

A class that describes the reason for a validation failure.

Optional failed

failed: undefined | false | true

A flag describing whether or not validation failed.

Optional failedTests

failedTests: VnetValidationTestFailure[]

A list of tests that failed in the validation.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetValidationFailureDetails"

type

type: object

className

className: string = "VnetValidationFailureDetails"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

failed

failed: object

serializedName

serializedName: string = "properties.failed"

type

type: object

name

name: "Boolean" = "Boolean"

failedTests

failedTests: object

serializedName

serializedName: string = "properties.failedTests"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "VnetValidationTestFailure"

name

name: "Composite" = "Composite"

Const VnetValidationTestFailure

VnetValidationTestFailure: object

A class that describes a test that failed during NSG and UDR validation.

Optional details

details: undefined | string

The details of what caused the failure, e.g. the blocking rule name, etc.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetValidationTestFailure"

Optional testName

testName: undefined | string

The name of the test that failed.

type

type: object

className

className: string = "VnetValidationTestFailure"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

details

details: object

serializedName

serializedName: string = "properties.details"

type

type: object

name

name: "String" = "String"

testName

testName: object

serializedName

serializedName: string = "properties.testName"

type

type: object

name

name: "String" = "String"

Const WebAppCollection

WebAppCollection: object
interface

Collection of App Service apps.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WebAppCollection"

__@iterator

  • __@iterator(): IterableIterator<Site>
  • Iterator

    Returns IterableIterator<Site>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<Site>[]): Site[]
  • concat(...items: (T | ConcatArray<T>)[]): Site[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Site>[]

      Additional items to add to the end of array1.

    Returns Site[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Site[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Site]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Site]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: Site, index: number, array: Site[]): boolean
        • Parameters

          • value: Site
          • index: number
          • array: Site[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Site, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Site

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Site[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: Site

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Site, index: number, array: Site[]): boolean
        • Parameters

          • value: Site
          • index: number
          • array: Site[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: Site, index: number, array: Site[]): any
        • Parameters

          • value: Site
          • index: number
          • array: Site[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Site[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Site | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: Site

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: Site, index: number, obj: Site[]): boolean
        • Parameters

          • this: void
          • value: Site
          • index: number
          • obj: Site[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: Site, index: number, obj: Site[]): boolean
        • Parameters

          • value: Site
          • index: number
          • obj: Site[]

          Returns boolean

    • Optional thisArg: any

    Returns Site | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: Site, index: number, obj: Site[]): boolean
        • Parameters

          • value: Site
          • index: number
          • obj: Site[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: Site, index: number, array: Site[]): void
        • Parameters

          • value: Site
          • index: number
          • array: Site[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Site, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Site

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Site, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Site

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Site, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Site

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: Site, index: number, array: Site[]): U
        • Parameters

          • value: Site
          • index: number
          • array: Site[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): Site | undefined
  • Removes the last element from an array and returns it.

    Returns Site | undefined

push

  • push(...items: Site[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Site[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Site
  • reduce(callbackfn: function, initialValue: Site): Site
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: Site, currentValue: Site, currentIndex: number, array: Site[]): Site
        • Parameters

          • previousValue: Site
          • currentValue: Site
          • currentIndex: number
          • array: Site[]

          Returns Site

    Returns Site

  • Parameters

    • callbackfn: function
        • (previousValue: Site, currentValue: Site, currentIndex: number, array: Site[]): Site
        • Parameters

          • previousValue: Site
          • currentValue: Site
          • currentIndex: number
          • array: Site[]

          Returns Site

    • initialValue: Site

    Returns Site

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Site, currentIndex: number, array: Site[]): U
        • Parameters

          • previousValue: U
          • currentValue: Site
          • currentIndex: number
          • array: Site[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Site
  • reduceRight(callbackfn: function, initialValue: Site): Site
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: Site, currentValue: Site, currentIndex: number, array: Site[]): Site
        • Parameters

          • previousValue: Site
          • currentValue: Site
          • currentIndex: number
          • array: Site[]

          Returns Site

    Returns Site

  • Parameters

    • callbackfn: function
        • (previousValue: Site, currentValue: Site, currentIndex: number, array: Site[]): Site
        • Parameters

          • previousValue: Site
          • currentValue: Site
          • currentIndex: number
          • array: Site[]

          Returns Site

    • initialValue: Site

    Returns Site

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Site, currentIndex: number, array: Site[]): U
        • Parameters

          • previousValue: U
          • currentValue: Site
          • currentIndex: number
          • array: Site[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): Site[]
  • Reverses the elements in an Array.

    Returns Site[]

shift

  • shift(): Site | undefined
  • Removes the first element from an array and returns it.

    Returns Site | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Site[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Site[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: Site, index: number, array: Site[]): boolean
        • Parameters

          • value: Site
          • index: number
          • array: Site[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Site[]
  • splice(start: number, deleteCount: number, ...items: Site[]): Site[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Site[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Site[]

      Elements to insert into the array in place of the deleted elements.

    Returns Site[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: Site[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Site[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<Site>
  • Returns an iterable of values in the array

    Returns IterableIterator<Site>

type

type: object

className

className: string = "WebAppCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Site"

name

name: "Composite" = "Composite"

Const WebAppInstanceCollection

WebAppInstanceCollection: object
interface

Collection of app instances.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WebAppInstanceCollection"

__@iterator

  • __@iterator(): IterableIterator<SiteInstance>
  • Iterator

    Returns IterableIterator<SiteInstance>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<SiteInstance>[]): SiteInstance[]
  • concat(...items: (T | ConcatArray<T>)[]): SiteInstance[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<SiteInstance>[]

      Additional items to add to the end of array1.

    Returns SiteInstance[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns SiteInstance[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, SiteInstance]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, SiteInstance]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: SiteInstance, index: number, array: SiteInstance[]): boolean
        • Parameters

          • value: SiteInstance
          • index: number
          • array: SiteInstance[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: SiteInstance, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: SiteInstance

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): SiteInstance[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: SiteInstance

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SiteInstance, index: number, array: SiteInstance[]): boolean
        • Parameters

          • value: SiteInstance
          • index: number
          • array: SiteInstance[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: SiteInstance, index: number, array: SiteInstance[]): any
        • Parameters

          • value: SiteInstance
          • index: number
          • array: SiteInstance[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns SiteInstance[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): SiteInstance | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: SiteInstance

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: SiteInstance, index: number, obj: SiteInstance[]): boolean
        • Parameters

          • this: void
          • value: SiteInstance
          • index: number
          • obj: SiteInstance[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: SiteInstance, index: number, obj: SiteInstance[]): boolean
        • Parameters

          • value: SiteInstance
          • index: number
          • obj: SiteInstance[]

          Returns boolean

    • Optional thisArg: any

    Returns SiteInstance | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: SiteInstance, index: number, obj: SiteInstance[]): boolean
        • Parameters

          • value: SiteInstance
          • index: number
          • obj: SiteInstance[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: SiteInstance, index: number, array: SiteInstance[]): void
        • Parameters

          • value: SiteInstance
          • index: number
          • array: SiteInstance[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: SiteInstance, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: SiteInstance

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: SiteInstance, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: SiteInstance

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: SiteInstance, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: SiteInstance

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: SiteInstance, index: number, array: SiteInstance[]): U
        • Parameters

          • value: SiteInstance
          • index: number
          • array: SiteInstance[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): SiteInstance | undefined
  • Removes the last element from an array and returns it.

    Returns SiteInstance | undefined

push

  • push(...items: SiteInstance[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: SiteInstance[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): SiteInstance
  • reduce(callbackfn: function, initialValue: SiteInstance): SiteInstance
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: SiteInstance, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): SiteInstance
        • Parameters

          • previousValue: SiteInstance
          • currentValue: SiteInstance
          • currentIndex: number
          • array: SiteInstance[]

          Returns SiteInstance

    Returns SiteInstance

  • Parameters

    • callbackfn: function
        • (previousValue: SiteInstance, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): SiteInstance
        • Parameters

          • previousValue: SiteInstance
          • currentValue: SiteInstance
          • currentIndex: number
          • array: SiteInstance[]

          Returns SiteInstance

    • initialValue: SiteInstance

    Returns SiteInstance

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): U
        • Parameters

          • previousValue: U
          • currentValue: SiteInstance
          • currentIndex: number
          • array: SiteInstance[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): SiteInstance
  • reduceRight(callbackfn: function, initialValue: SiteInstance): SiteInstance
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: SiteInstance, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): SiteInstance
        • Parameters

          • previousValue: SiteInstance
          • currentValue: SiteInstance
          • currentIndex: number
          • array: SiteInstance[]

          Returns SiteInstance

    Returns SiteInstance

  • Parameters

    • callbackfn: function
        • (previousValue: SiteInstance, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): SiteInstance
        • Parameters

          • previousValue: SiteInstance
          • currentValue: SiteInstance
          • currentIndex: number
          • array: SiteInstance[]

          Returns SiteInstance

    • initialValue: SiteInstance

    Returns SiteInstance

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): U
        • Parameters

          • previousValue: U
          • currentValue: SiteInstance
          • currentIndex: number
          • array: SiteInstance[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): SiteInstance[]
  • Reverses the elements in an Array.

    Returns SiteInstance[]

shift

  • shift(): SiteInstance | undefined
  • Removes the first element from an array and returns it.

    Returns SiteInstance | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): SiteInstance[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns SiteInstance[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: SiteInstance, index: number, array: SiteInstance[]): boolean
        • Parameters

          • value: SiteInstance
          • index: number
          • array: SiteInstance[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): SiteInstance[]
  • splice(start: number, deleteCount: number, ...items: SiteInstance[]): SiteInstance[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns SiteInstance[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: SiteInstance[]

      Elements to insert into the array in place of the deleted elements.

    Returns SiteInstance[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: SiteInstance[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: SiteInstance[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<SiteInstance>
  • Returns an iterable of values in the array

    Returns IterableIterator<SiteInstance>

type

type: object

className

className: string = "WebAppInstanceCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "SiteInstance"

name

name: "Composite" = "Composite"

Const WebJob

WebJob: object

Web Job Information.

Optional error

error: undefined | string

Error information.

Optional extraInfoUrl

extraInfoUrl: undefined | string

Extra Info URL.

Optional id

id: undefined | string

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

Kind of resource.

Optional name

name: undefined | string

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runCommand

runCommand: undefined | string

Run command.

serializedName

serializedName: string = "WebJob"

Optional settings

settings: undefined | object

Job settings.

Optional url

url: undefined | string

Job URL.

Optional usingSdk

usingSdk: undefined | false | true

Using SDK?

Optional webJobType

webJobType: WebJobType

Job type. Possible values include: 'Continuous', 'Triggered'

type

type: object

className

className: string = "WebJob"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "properties.error"

type

type: object

name

name: "String" = "String"

extraInfoUrl

extraInfoUrl: object

serializedName

serializedName: string = "properties.extra_info_url"

type

type: object

name

name: "String" = "String"

runCommand

runCommand: object

serializedName

serializedName: string = "properties.run_command"

type

type: object

name

name: "String" = "String"

settings

settings: object

serializedName

serializedName: string = "properties.settings"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "Object" = "Object"

url

url: object

serializedName

serializedName: string = "properties.url"

type

type: object

name

name: "String" = "String"

usingSdk

usingSdk: object

serializedName

serializedName: string = "properties.using_sdk"

type

type: object

name

name: "Boolean" = "Boolean"

webJobType

webJobType: object

serializedName

serializedName: string = "properties.web_job_type"

type

type: object

allowedValues

allowedValues: string[] = ["Continuous","Triggered"]

name

name: "Enum" = "Enum"

Const WebJobCollection

WebJobCollection: object
interface

Collection of Kudu web job information elements.

extends

Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WebJobCollection"

__@iterator

  • __@iterator(): IterableIterator<WebJob>
  • Iterator

    Returns IterableIterator<WebJob>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • concat(...items: ConcatArray<WebJob>[]): WebJob[]
  • concat(...items: (T | ConcatArray<T>)[]): WebJob[]
  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<WebJob>[]

      Additional items to add to the end of array1.

    Returns WebJob[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WebJob[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, WebJob]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WebJob]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

        • (value: WebJob, index: number, array: WebJob[]): boolean
        • Parameters

          • value: WebJob
          • index: number
          • array: WebJob[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: WebJob, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WebJob

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WebJob[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    • S: WebJob

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: WebJob, index: number, array: WebJob[]): boolean
        • Parameters

          • value: WebJob
          • index: number
          • array: WebJob[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

        • (value: WebJob, index: number, array: WebJob[]): any
        • Parameters

          • value: WebJob
          • index: number
          • array: WebJob[]

          Returns any

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WebJob[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WebJob | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    • S: WebJob

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

        • (this: void, value: WebJob, index: number, obj: WebJob[]): boolean
        • Parameters

          • this: void
          • value: WebJob
          • index: number
          • obj: WebJob[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
        • (value: WebJob, index: number, obj: WebJob[]): boolean
        • Parameters

          • value: WebJob
          • index: number
          • obj: WebJob[]

          Returns boolean

    • Optional thisArg: any

    Returns WebJob | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

        • (value: WebJob, index: number, obj: WebJob[]): boolean
        • Parameters

          • value: WebJob
          • index: number
          • obj: WebJob[]

          Returns boolean

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

        • (value: WebJob, index: number, array: WebJob[]): void
        • Parameters

          • value: WebJob
          • index: number
          • array: WebJob[]

          Returns void

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: WebJob, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WebJob

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: WebJob, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WebJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: WebJob, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WebJob

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

        • (value: WebJob, index: number, array: WebJob[]): U
        • Parameters

          • value: WebJob
          • index: number
          • array: WebJob[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • pop(): WebJob | undefined
  • Removes the last element from an array and returns it.

    Returns WebJob | undefined

push

  • push(...items: WebJob[]): number
  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: WebJob[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): WebJob
  • reduce(callbackfn: function, initialValue: WebJob): WebJob
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: WebJob, currentValue: WebJob, currentIndex: number, array: WebJob[]): WebJob
        • Parameters

          • previousValue: WebJob
          • currentValue: WebJob
          • currentIndex: number
          • array: WebJob[]

          Returns WebJob

    Returns WebJob

  • Parameters

    • callbackfn: function
        • (previousValue: WebJob, currentValue: WebJob, currentIndex: number, array: WebJob[]): WebJob
        • Parameters

          • previousValue: WebJob
          • currentValue: WebJob
          • currentIndex: number
          • array: WebJob[]

          Returns WebJob

    • initialValue: WebJob

    Returns WebJob

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: WebJob, currentIndex: number, array: WebJob[]): U
        • Parameters

          • previousValue: U
          • currentValue: WebJob
          • currentIndex: number
          • array: WebJob[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): WebJob
  • reduceRight(callbackfn: function, initialValue: WebJob): WebJob
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: WebJob, currentValue: WebJob, currentIndex: number, array: WebJob[]): WebJob
        • Parameters

          • previousValue: WebJob
          • currentValue: WebJob
          • currentIndex: number
          • array: WebJob[]

          Returns WebJob

    Returns WebJob

  • Parameters

    • callbackfn: function
        • (previousValue: WebJob, currentValue: WebJob, currentIndex: number, array: WebJob[]): WebJob
        • Parameters

          • previousValue: WebJob
          • currentValue: WebJob
          • currentIndex: number
          • array: WebJob[]

          Returns WebJob

    • initialValue: WebJob

    Returns WebJob

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: WebJob, currentIndex: number, array: WebJob[]): U
        • Parameters

          • previousValue: U
          • currentValue: WebJob
          • currentIndex: number
          • array: WebJob[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • reverse(): WebJob[]
  • Reverses the elements in an Array.

    Returns WebJob[]

shift

  • shift(): WebJob | undefined
  • Removes the first element from an array and returns it.

    Returns WebJob | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): WebJob[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WebJob[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

        • (value: WebJob, index: number, array: WebJob[]): boolean
        • Parameters

          • value: WebJob
          • index: number
          • array: WebJob[]

          Returns boolean

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): WebJob[]
  • splice(start: number, deleteCount: number, ...items: WebJob[]): WebJob[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WebJob[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WebJob[]

      Elements to insert into the array in place of the deleted elements.

    Returns WebJob[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • unshift(...items: WebJob[]): number
  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: WebJob[]

      Elements to insert at the start of the Array.

    Returns number

values

  • values(): IterableIterator<WebJob>
  • Returns an iterable of values in the array

    Returns IterableIterator<WebJob>

type

type: object

className

className: string = "WebJobCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WebJob"

name

name: "Composite" = "Composite"

Const WorkerPool

WorkerPool: object

Worker pool of an App Service Environment.

Optional computeMode

computeMode: ComputeModeOptions

Shared or dedicated app hosting. Possible values include: 'Shared', 'Dedicated', 'Dynamic'

Optional instanceNames

instanceNames: string[]

Names of all instances in the worker pool (read only). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkerPool"

Optional workerCount

workerCount: undefined | number

Number of instances in the worker pool.

Optional workerSize

workerSize: undefined | string

VM size of the worker pool instances.

Optional workerSizeId

workerSizeId: undefined | number

Worker size ID for referencing this worker pool.

type

type: object

className

className: string = "WorkerPool"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

computeMode

computeMode: object

serializedName

serializedName: string = "computeMode"

type

type: object

allowedValues

allowedValues: string[] = ["Shared","Dedicated","Dynamic"]

name

name: "Enum" = "Enum"

instanceNames

instanceNames: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "instanceNames"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

workerCount

workerCount: object

serializedName

serializedName: string = "workerCount"

type

type: object

name

name: "Number" = "Number"

workerSize

workerSize: object

serializedName

serializedName: string = "workerSize"

type

type: object

name

name: "String" = "String"

workerSizeId

workerSizeId: object

serializedName

serializedName: string = "workerSizeId"

type

type: object

name

name: "Number" = "Number"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const backupId

backupId: object

parameterPath

parameterPath: string = "backupId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "backupId"

type

type: object

name

name: "String" = "String"

Const baseAddress

baseAddress: object

parameterPath

parameterPath: string = "baseAddress"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "baseAddress"

type

type: object

name

name: "String" = "String"

Const billingLocation

billingLocation: object

parameterPath

parameterPath: string[] = ["options","billingLocation"]

mapper

mapper: object

serializedName

serializedName: string = "billingLocation"

type

type: object

name

name: "String" = "String"

Const deleteEmptyServerFarm

deleteEmptyServerFarm: object

parameterPath

parameterPath: string[] = ["options","deleteEmptyServerFarm"]

mapper

mapper: object

serializedName

serializedName: string = "deleteEmptyServerFarm"

type

type: object

name

name: "Boolean" = "Boolean"

Const deleteMetrics

deleteMetrics: object

parameterPath

parameterPath: string[] = ["options","deleteMetrics"]

mapper

mapper: object

serializedName

serializedName: string = "deleteMetrics"

type

type: object

name

name: "Boolean" = "Boolean"

Const detailed

detailed: object

parameterPath

parameterPath: string[] = ["options","detailed"]

mapper

mapper: object

serializedName

serializedName: string = "detailed"

type

type: object

name

name: "Boolean" = "Boolean"

Const details

details: object

parameterPath

parameterPath: string[] = ["options","details"]

mapper

mapper: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Boolean" = "Boolean"

Const domainOwnershipIdentifierName

domainOwnershipIdentifierName: object

parameterPath

parameterPath: string = "domainOwnershipIdentifierName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "domainOwnershipIdentifierName"

type

type: object

name

name: "String" = "String"

Const durationInSeconds

durationInSeconds: object

parameterPath

parameterPath: string[] = ["options","durationInSeconds"]

mapper

mapper: object

serializedName

serializedName: string = "durationInSeconds"

type

type: object

name

name: "Number" = "Number"

Const entityName

entityName: object

parameterPath

parameterPath: string = "entityName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "entityName"

type

type: object

name

name: "String" = "String"

Const environmentName

environmentName: object

parameterPath

parameterPath: string = "environmentName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "environmentName"

type

type: object

name

name: "String" = "String"

Const expiredOnly

expiredOnly: object

parameterPath

parameterPath: string[] = ["options","expiredOnly"]

mapper

mapper: object

serializedName

serializedName: string = "expiredOnly"

type

type: object

name

name: "Boolean" = "Boolean"

Const featured

featured: object

parameterPath

parameterPath: string[] = ["options","featured"]

mapper

mapper: object

serializedName

serializedName: string = "featured"

type

type: object

name

name: "Boolean" = "Boolean"

Const filter

filter: object

parameterPath

parameterPath: string[] = ["options","filter"]

skipEncoding

skipEncoding: true = true

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const functionName

functionName: object

parameterPath

parameterPath: string = "functionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "functionName"

type

type: object

name

name: "String" = "String"

Const gatewayName

gatewayName: object

parameterPath

parameterPath: string = "gatewayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "gatewayName"

type

type: object

name

name: "String" = "String"

Const hostName0

hostName0: object

parameterPath

parameterPath: string[] = ["options","hostName"]

mapper

mapper: object

serializedName

serializedName: string = "hostName"

type

type: object

name

name: "String" = "String"

Const hostName1

hostName1: object

parameterPath

parameterPath: string = "hostName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "hostName"

type

type: object

name

name: "String" = "String"

Const hostingEnvironmentName

hostingEnvironmentName: object

parameterPath

parameterPath: string = "hostingEnvironmentName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "hostingEnvironmentName"

type

type: object

name

name: "String" = "String"

Const id

id: object

parameterPath

parameterPath: string = "id"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const includeSlots

includeSlots: object

parameterPath

parameterPath: string[] = ["options","includeSlots"]

mapper

mapper: object

serializedName

serializedName: string = "includeSlots"

type

type: object

name

name: "Boolean" = "Boolean"

Const instanceId

instanceId: object

parameterPath

parameterPath: string = "instanceId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "instanceId"

type

type: object

name

name: "String" = "String"

Const linuxDynamicWorkersEnabled

linuxDynamicWorkersEnabled: object

parameterPath

parameterPath: string[] = ["options","linuxDynamicWorkersEnabled"]

mapper

mapper: object

serializedName

serializedName: string = "linuxDynamicWorkersEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const linuxWorkersEnabled

linuxWorkersEnabled: object

parameterPath

parameterPath: string[] = ["options","linuxWorkersEnabled"]

mapper

mapper: object

serializedName

serializedName: string = "linuxWorkersEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

Const maxFrameLength

maxFrameLength: object

parameterPath

parameterPath: string[] = ["options","maxFrameLength"]

mapper

mapper: object

serializedName

serializedName: string = "maxFrameLength"

type

type: object

name

name: "Number" = "Number"

Const name

name: object

parameterPath

parameterPath: string = "name"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const namespaceName

namespaceName: object

parameterPath

parameterPath: string = "namespaceName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "namespaceName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: "String" = "String"

Const osType

osType: object

parameterPath

parameterPath: string[] = ["options","osType"]

mapper

mapper: object

serializedName

serializedName: string = "osType"

type

type: object

name

name: "String" = "String"

Const osTypeSelected

osTypeSelected: object

parameterPath

parameterPath: string[] = ["options","osTypeSelected"]

mapper

mapper: object

serializedName

serializedName: string = "osTypeSelected"

type

type: object

name

name: "String" = "String"

Const premierAddOnName

premierAddOnName: object

parameterPath

parameterPath: string = "premierAddOnName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "premierAddOnName"

type

type: object

name

name: "String" = "String"

Const processId

processId: object

parameterPath

parameterPath: string = "processId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "processId"

type

type: object

name

name: "String" = "String"

Const publicCertificateName

publicCertificateName: object

parameterPath

parameterPath: string = "publicCertificateName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "publicCertificateName"

type

type: object

name

name: "String" = "String"

Const recommendationId

recommendationId: object

parameterPath

parameterPath: string[] = ["options","recommendationId"]

mapper

mapper: object

serializedName

serializedName: string = "recommendationId"

type

type: object

name

name: "String" = "String"

Const relayName

relayName: object

parameterPath

parameterPath: string = "relayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "relayName"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

constraints

constraints: object

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[-\w\._\(\)]+[^\.]$/

type

type: object

name

name: "String" = "String"

Const routeName

routeName: object

parameterPath

parameterPath: string = "routeName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "routeName"

type

type: object

name

name: "String" = "String"

Const sasUrl

sasUrl: object

parameterPath

parameterPath: string[] = ["options","sasUrl"]

mapper

mapper: object

serializedName

serializedName: string = "sasUrl"

type

type: object

name

name: "String" = "String"

Const siteExtensionId

siteExtensionId: object

parameterPath

parameterPath: string = "siteExtensionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "siteExtensionId"

type

type: object

name

name: "String" = "String"

Const siteName

siteName: object

parameterPath

parameterPath: string = "siteName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "siteName"

type

type: object

name

name: "String" = "String"

Const skipToken

skipToken: object

parameterPath

parameterPath: string[] = ["options","skipToken"]

mapper

mapper: object

serializedName

serializedName: string = "$skipToken"

type

type: object

name

name: "String" = "String"

Const sku

sku: object

parameterPath

parameterPath: string[] = ["options","sku"]

mapper

mapper: object

serializedName

serializedName: string = "sku"

type

type: object

name

name: "String" = "String"

Const slot

slot: object

parameterPath

parameterPath: string = "slot"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "slot"

type

type: object

name

name: "String" = "String"

Const snapshotId

snapshotId: object

parameterPath

parameterPath: string = "snapshotId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "snapshotId"

type

type: object

name

name: "String" = "String"

Const softRestart

softRestart: object

parameterPath

parameterPath: string[] = ["options","softRestart"]

mapper

mapper: object

serializedName

serializedName: string = "softRestart"

type

type: object

name

name: "Boolean" = "Boolean"

Const sourceControlType

sourceControlType: object

parameterPath

parameterPath: string = "sourceControlType"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "sourceControlType"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const subscriptionName

subscriptionName: object

parameterPath

parameterPath: string = "subscriptionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionName"

type

type: object

name

name: "String" = "String"

Const synchronous

synchronous: object

parameterPath

parameterPath: string[] = ["options","synchronous"]

mapper

mapper: object

serializedName

serializedName: string = "synchronous"

type

type: object

name

name: "Boolean" = "Boolean"

Const threadId

threadId: object

parameterPath

parameterPath: string = "threadId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "threadId"

type

type: object

name

name: "String" = "String"

Const top

top: object

parameterPath

parameterPath: string[] = ["options","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: "String" = "String"

Const updateSeen

updateSeen: object

parameterPath

parameterPath: string[] = ["options","updateSeen"]

mapper

mapper: object

serializedName

serializedName: string = "updateSeen"

type

type: object

name

name: "Boolean" = "Boolean"

Const view

view: object

parameterPath

parameterPath: string = "view"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "view"

type

type: object

name

name: "String" = "String"

Const vnetName

vnetName: object

parameterPath

parameterPath: string = "vnetName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "vnetName"

type

type: object

name

name: "String" = "String"

Const webJobName

webJobName: object

parameterPath

parameterPath: string = "webJobName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "webJobName"

type

type: object

name

name: "String" = "String"

Const workerName

workerName: object

parameterPath

parameterPath: string = "workerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "workerName"

type

type: object

name

name: "String" = "String"

Const xenonWorkersEnabled

xenonWorkersEnabled: object

parameterPath

parameterPath: string[] = ["options","xenonWorkersEnabled"]

mapper

mapper: object

serializedName

serializedName: string = "xenonWorkersEnabled"

type

type: object

name

name: "Boolean" = "Boolean"

Generated using TypeDoc